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 3ecb3bccc..cacf3ecd2 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 @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -2169,6 +2165,206 @@ } } }, + "/enterprises/{enterprise}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an enterprise", + "description": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an enterprise", + "description": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an enterprise", + "description": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an enterprise", + "description": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/enterprises/{enterprise}/code-security/configurations": { "get": { "summary": "Get code security configurations for an enterprise", @@ -7327,6 +7523,206 @@ } } }, + "/organizations/{org}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an organization", + "description": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an organization", + "description": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/organizations/{org}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an organization", + "description": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an organization", + "description": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -7689,6 +8085,35 @@ "parameters": [ { "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "page_size", + "description": "The number of results per page (max 10).", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost-center" + ] + } } ], "responses": { @@ -7937,10 +8362,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -24569,50 +24991,182 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for organization", - "description": "Get a specific field for an organization-owned project.", + }, + "post": { + "summary": "Add a field to an organization-owned project.", + "description": "Add a field to an organization-owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-org", + "operationId": "projects/add-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { "$ref": "#/components/parameters/project-number" }, - { - "$ref": "#/components/parameters/field-id" - }, { "$ref": "#/components/parameters/org" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "issue_field_id": { + "type": "integer", + "description": "The ID of the IssueField to create the field for." + } + }, + "required": [ + "issue_field_id" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Response for adding a field to an organization-owned project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-v2-field" }, "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field" + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "304": { @@ -24623,6 +25177,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -24633,62 +25190,27 @@ } } }, - "/orgs/{org}/projectsV2/{project_number}/items": { + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { "get": { - "summary": "List items for an organization owned project", - "description": "List all items for a specific organization-owned project accessible by the authenticated user.", + "summary": "Get project field for organization", + "description": "Get a specific field for an organization-owned project.", "tags": [ "projects" ], - "operationId": "projects/list-items-for-org", + "operationId": "projects/get-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project" + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" }, "parameters": [ { "$ref": "#/components/parameters/project-number" }, { - "$ref": "#/components/parameters/org" - }, - { - "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.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - } - } - ] - } - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" + "$ref": "#/components/parameters/field-id" }, { - "$ref": "#/components/parameters/per-page" + "$ref": "#/components/parameters/org" } ], "responses": { @@ -24697,14 +25219,11 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-item-with-content" - } + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { "default": { - "$ref": "#/components/examples/projects-v2-item-with-content" + "$ref": "#/components/examples/projects-v2-field" } } } @@ -24729,119 +25248,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "items" - } - }, - "post": { - "summary": "Add item to organization owned project", - "description": "Add an issue or pull request item to the specified organization owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/add-item-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/project-number" - } - ], - "requestBody": { - "required": true, - "description": "Details of the item to add to the project.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The numeric ID of the issue or pull request to add to the project." - } - }, - "required": [ - "type", - "id" - ] - }, - "examples": { - "issue": { - "value": { - "type": "Issue", - "id": 3 - } - }, - "pull_request": { - "value": { - "type": "PullRequest", - "id": 3 - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2-item-simple" - }, - "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" - }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "items" + "subcategory": "fields" } } }, - "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + "/orgs/{org}/projectsV2/{project_number}/items": { "get": { - "summary": "Get an item for an organization owned project", - "description": "Get a specific item from an organization-owned project.", + "summary": "List items for an organization owned project", + "description": "List all items for a specific organization-owned project accessible by the authenticated user.", "tags": [ "projects" ], - "operationId": "projects/get-org-item", + "operationId": "projects/list-items-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project" + "url": "https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project" }, "parameters": [ { @@ -24851,11 +25272,17 @@ "$ref": "#/components/parameters/org" }, { - "$ref": "#/components/parameters/item-id" + "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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } }, { "name": "fields", - "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", + "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": { @@ -24872,6 +25299,15 @@ } ] } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" } ], "responses": { @@ -24880,7 +25316,190 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/projects-v2-item-with-content" + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "post": { + "summary": "Add item to organization owned project", + "description": "Add an issue or pull request item to the specified organization owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-item-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "description": "Details of the item to add to the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The numeric ID of the issue or pull request to add to the project." + } + }, + "required": [ + "type", + "id" + ] + }, + "examples": { + "issue": { + "value": { + "type": "Issue", + "id": 3 + } + }, + "pull_request": { + "value": { + "type": "PullRequest", + "id": 3 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-simple" + }, + "examples": { + "issue": { + "$ref": "#/components/examples/projects-v2-item-simple" + }, + "pull_request": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + "get": { + "summary": "Get an item for an organization owned project", + "description": "Get a specific item from an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-org-item", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$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.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-with-content" }, "examples": { "default": { @@ -26799,6 +27418,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -29791,254 +30413,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { - "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", @@ -30379,563 +30753,6 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "type": "string", - "examples": [ - "write" - ] - } - } - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-collaborator-permission" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-collaborator-permission" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", @@ -31602,6 +31419,218 @@ } } }, + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for a repository", + "description": "Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for a repository", + "description": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for a repository", + "description": "Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for a repository", + "description": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/repos/{owner}/{repo}/actions/cache/usage": { "get": { "summary": "Get GitHub Actions cache usage for a repository", @@ -62081,6 +62110,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -62207,7 +62239,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -62242,6 +62274,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -62249,6 +62284,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -62258,6 +62298,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -62286,7 +62338,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -67201,254 +67253,6 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { - "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", @@ -75787,120 +75591,301 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}": { + "get": { + "summary": "Get project for user", + "description": "Get a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields": { + "get": { + "summary": "List project fields for user", + "description": "List all fields for a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/list-fields-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}": { - "get": { - "summary": "Get project for user", - "description": "Get a specific user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "$ref": "#/components/parameters/project-number" + "$ref": "#/components/parameters/username" }, { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/project-number" } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2" + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "projects" - } - } - }, - "/users/{username}/projectsV2/{project_number}/fields": { - "get": { - "summary": "List project fields for user", - "description": "List all fields for a specific user-owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/list-fields-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - } - ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-field" - } + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field-items" + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "304": { @@ -75911,6 +75896,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -87612,7 +87600,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-created": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "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-milestone-created" } } } @@ -87634,11 +87715,11 @@ } } }, - "milestone-created": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -87705,7 +87786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -87727,11 +87808,11 @@ } } }, - "milestone-deleted": { + "milestone-edited": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -87798,7 +87879,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -87820,11 +87901,11 @@ } } }, - "milestone-edited": { + "milestone-opened": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -87891,7 +87972,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -87913,13 +87994,13 @@ } } }, - "milestone-opened": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -87984,7 +88065,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-org-block-blocked" } } } @@ -87997,20 +88078,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "org_block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "org-block-blocked": { + "org-block-unblocked": { "post": { "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, @@ -88077,7 +88158,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -88099,13 +88180,13 @@ } } }, - "org-block-unblocked": { + "organization-deleted": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -88170,7 +88251,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -88183,7 +88264,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "organization", "supported-webhook-types": [ "organization", "business", @@ -88192,11 +88273,11 @@ } } }, - "organization-deleted": { + "organization-member-added": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88263,7 +88344,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -88285,11 +88366,11 @@ } } }, - "organization-member-added": { + "organization-member-invited": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88356,7 +88437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -88378,11 +88459,11 @@ } } }, - "organization-member-invited": { + "organization-member-removed": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88449,7 +88530,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -88471,11 +88552,11 @@ } } }, - "organization-member-removed": { + "organization-renamed": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88542,7 +88623,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -88564,13 +88645,13 @@ } } }, - "organization-renamed": { + "package-published": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -88635,7 +88716,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -88648,20 +88729,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "package", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "package-published": { + "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, @@ -88728,7 +88809,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -88750,13 +88831,12 @@ } } }, - "package-updated": { + "page-build": { "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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 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/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/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/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -88821,7 +88901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -88834,7 +88914,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "page_build", "supported-webhook-types": [ "repository", "organization", @@ -88843,12 +88923,13 @@ } } }, - "page-build": { + "personal-access-token-request-approved": { "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/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/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 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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -88860,9 +88941,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -88870,7 +88951,15 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, "schema": { "type": "string" } @@ -88886,7 +88975,59 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "repository", + "example": "integration", + "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-personal-access-token-request-approved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app", + "organization" + ] + } + } + }, + "personal-access-token-request-cancelled": { + "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/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/webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -88899,6 +89040,38 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "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": "integration", + "schema": { + "type": "string" + } + }, { "name": "X-Hub-Signature-256", "in": "header", @@ -88913,7 +89086,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -88926,20 +89099,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "personal-access-token-request-approved": { + "personal-access-token-request-created": { "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/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", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -89006,7 +89178,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -89027,11 +89199,11 @@ } } }, - "personal-access-token-request-cancelled": { + "personal-access-token-request-denied": { "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/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", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -89098,7 +89270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -89119,13 +89291,12 @@ } } }, - "personal-access-token-request-created": { + "ping": { "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/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 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/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -89137,9 +89308,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -89147,31 +89318,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" } @@ -89190,7 +89361,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$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" + } } } } @@ -89202,22 +89388,26 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "ping", "supported-webhook-types": [ + "repository", + "organization", "app", - "organization" + "business", + "marketplace" ] } } }, - "personal-access-token-request-denied": { + "project-card-converted": { "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/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", + "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -89229,9 +89419,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -89239,31 +89429,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" } @@ -89282,7 +89472,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -89295,20 +89485,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "project_card", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "ping": { + "project-card-created": { "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 card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -89373,22 +89565,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-project-card-created" } } } @@ -89400,24 +89577,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", - "app", - "business", - "marketplace" + "app" ] } } }, - "project-card-converted": { + "project-card-deleted": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -89484,7 +89658,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -89506,11 +89680,11 @@ } } }, - "project-card-created": { + "project-card-edited": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -89577,7 +89751,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -89599,11 +89773,11 @@ } } }, - "project-card-deleted": { + "project-card-moved": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#project_card" }, @@ -89670,7 +89844,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -89692,13 +89866,13 @@ } } }, - "project-card-edited": { + "project-closed": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -89763,7 +89937,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -89776,7 +89950,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -89785,13 +89959,13 @@ } } }, - "project-card-moved": { + "project-column-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -89856,7 +90030,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -89869,7 +90043,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -89878,13 +90052,13 @@ } } }, - "project-closed": { + "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -89949,7 +90123,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -89962,7 +90136,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -89971,11 +90145,11 @@ } } }, - "project-column-created": { + "project-column-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -90042,7 +90216,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -90064,11 +90238,11 @@ } } }, - "project-column-deleted": { + "project-column-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -90135,7 +90309,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -90157,13 +90331,13 @@ } } }, - "project-column-edited": { + "project-created": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -90228,7 +90402,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -90241,7 +90415,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -90250,13 +90424,13 @@ } } }, - "project-column-moved": { + "project-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -90321,7 +90495,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -90334,7 +90508,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -90343,11 +90517,11 @@ } } }, - "project-created": { + "project-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -90414,7 +90588,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -90436,11 +90610,11 @@ } } }, - "project-deleted": { + "project-reopened": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -90507,7 +90681,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -90529,13 +90703,13 @@ } } }, - "project-edited": { + "projects-v2-closed": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -90557,7 +90731,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -90600,7 +90774,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -90612,23 +90786,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "project-reopened": { + "projects-v2-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -90650,7 +90823,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -90693,7 +90866,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -90705,21 +90878,20 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "projects-v2-closed": { + "projects-v2-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/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/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", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -90786,7 +90958,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -90807,11 +90979,11 @@ } } }, - "projects-v2-created": { + "projects-v2-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/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/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", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -90878,7 +91050,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -90899,13 +91071,13 @@ } } }, - "projects-v2-deleted": { + "projects-v2-item-archived": { "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/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/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 an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/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/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -90927,7 +91099,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -90970,7 +91142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -90984,20 +91156,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-edited": { + "projects-v2-item-converted": { "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/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/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 an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -91019,7 +91191,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -91062,7 +91234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -91076,18 +91248,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-archived": { + "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/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/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/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91154,7 +91326,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -91175,11 +91347,11 @@ } } }, - "projects-v2-item-converted": { + "projects-v2-item-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/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/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", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91246,7 +91418,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -91267,11 +91439,11 @@ } } }, - "projects-v2-item-created": { + "projects-v2-item-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/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/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", + "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/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91338,7 +91510,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -91359,11 +91531,11 @@ } } }, - "projects-v2-item-deleted": { + "projects-v2-item-reordered": { "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/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/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", + "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/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91430,7 +91602,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -91451,11 +91623,11 @@ } } }, - "projects-v2-item-edited": { + "projects-v2-item-restored": { "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/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/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 archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/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/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91522,7 +91694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -91543,13 +91715,13 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-reopened": { "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/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/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", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -91571,7 +91743,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -91614,7 +91786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -91628,20 +91800,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-restored": { + "projects-v2-status-update-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/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/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/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "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/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/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -91663,7 +91835,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -91706,7 +91878,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -91720,20 +91892,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-reopened": { + "projects-v2-status-update-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/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/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 a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -91755,7 +91927,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -91798,7 +91970,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -91812,18 +91984,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-created": { + "projects-v2-status-update-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/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", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, @@ -91890,7 +92062,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -91911,13 +92083,12 @@ } } }, - "projects-v2-status-update-deleted": { + "public": { "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/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 repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/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/webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -91939,7 +92110,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "issues", "schema": { "type": "string" } @@ -91982,7 +92153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-public" } } } @@ -91994,22 +92165,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "public", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-status-update-edited": { + "pull-request-assigned": { "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/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -92031,7 +92203,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "issues", "schema": { "type": "string" } @@ -92074,7 +92246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -92086,21 +92258,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "pull_request", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "public": { + "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -92165,7 +92339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -92178,7 +92352,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "public", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -92187,11 +92361,11 @@ } } }, - "pull-request-assigned": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92258,7 +92432,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -92280,11 +92454,11 @@ } } }, - "pull-request-auto-merge-disabled": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92351,7 +92525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -92373,11 +92547,11 @@ } } }, - "pull-request-auto-merge-enabled": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92444,7 +92618,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -92466,11 +92640,11 @@ } } }, - "pull-request-closed": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92537,7 +92711,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -92559,11 +92733,11 @@ } } }, - "pull-request-converted-to-draft": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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 removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92630,7 +92804,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -92652,11 +92826,11 @@ } } }, - "pull-request-demilestoned": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92723,7 +92897,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -92745,11 +92919,11 @@ } } }, - "pull-request-dequeued": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92816,7 +92990,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -92838,11 +93012,11 @@ } } }, - "pull-request-edited": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92909,7 +93083,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -92931,11 +93105,11 @@ } } }, - "pull-request-enqueued": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93002,7 +93176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -93024,11 +93198,11 @@ } } }, - "pull-request-labeled": { + "pull-request-milestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93095,7 +93269,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -93117,11 +93291,11 @@ } } }, - "pull-request-locked": { + "pull-request-opened": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93188,7 +93362,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -93210,11 +93384,11 @@ } } }, - "pull-request-milestoned": { + "pull-request-ready-for-review": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "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/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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93281,7 +93455,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -93303,11 +93477,11 @@ } } }, - "pull-request-opened": { + "pull-request-reopened": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93374,7 +93548,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -93396,13 +93570,13 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-review-comment-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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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", + "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -93467,7 +93641,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -93480,7 +93654,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -93489,13 +93663,13 @@ } } }, - "pull-request-reopened": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", + "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -93560,7 +93734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -93573,7 +93747,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -93582,11 +93756,11 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-review-comment-edited": { "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, @@ -93653,7 +93827,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -93675,13 +93849,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-review-dismissed": { "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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 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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -93746,7 +93920,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -93759,7 +93933,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -93768,13 +93942,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-review-edited": { "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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 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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -93839,7 +94013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -93852,7 +94026,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -93861,13 +94035,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-review-request-removed": { "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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -93932,7 +94106,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -93945,7 +94119,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -93954,11 +94128,104 @@ } } }, - "pull-request-review-edited": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#pull_request" + }, + "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-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-submitted": { "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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -94025,7 +94292,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -94047,106 +94314,13 @@ } } }, - "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" - }, - "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-request-removed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-requested": { + "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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 comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -94211,7 +94385,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -94224,7 +94398,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -94233,13 +94407,13 @@ } } }, - "pull-request-review-submitted": { + "pull-request-review-thread-unresolved": { "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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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", + "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/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -94304,7 +94478,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -94317,7 +94491,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -94326,13 +94500,13 @@ } } }, - "pull-request-review-thread-resolved": { + "pull-request-synchronize": { "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/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -94397,7 +94571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -94410,7 +94584,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -94419,13 +94593,13 @@ } } }, - "pull-request-review-thread-unresolved": { + "pull-request-unassigned": { "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/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -94490,7 +94664,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -94503,7 +94677,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -94512,11 +94686,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94583,7 +94757,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -94605,11 +94779,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-unlocked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94676,7 +94850,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -94698,13 +94872,12 @@ } } }, - "pull-request-unlabeled": { + "push": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -94769,7 +94942,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-push" } } } @@ -94782,7 +94955,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -94791,13 +94964,13 @@ } } }, - "pull-request-unlocked": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -94862,7 +95035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -94875,7 +95048,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -94884,12 +95057,13 @@ } } }, - "push": { + "registry-package-updated": { "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 relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -94954,7 +95128,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -94967,7 +95141,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -94976,13 +95150,13 @@ } } }, - "registry-package-published": { + "release-created": { "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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 relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -95047,7 +95221,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -95060,7 +95234,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -95069,13 +95243,13 @@ } } }, - "registry-package-updated": { + "release-deleted": { "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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 relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -95140,7 +95314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -95153,7 +95327,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -95162,11 +95336,11 @@ } } }, - "release-created": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95233,7 +95407,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -95255,11 +95429,11 @@ } } }, - "release-deleted": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#release" }, @@ -95326,7 +95500,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -95348,11 +95522,11 @@ } } }, - "release-edited": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95419,7 +95593,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -95441,11 +95615,11 @@ } } }, - "release-prereleased": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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 was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95512,7 +95686,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -95534,11 +95708,11 @@ } } }, - "release-published": { + "release-unpublished": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95605,7 +95779,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -95627,13 +95801,13 @@ } } }, - "release-released": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/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/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -95698,7 +95872,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -95711,7 +95885,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -95720,13 +95894,13 @@ } } }, - "release-unpublished": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/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/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -95791,7 +95965,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -95804,7 +95978,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -95813,13 +95987,13 @@ } } }, - "repository-advisory-published": { + "repository-archived": { "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/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 repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -95884,7 +96058,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -95897,8 +96071,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -95906,13 +96081,13 @@ } } }, - "repository-advisory-reported": { + "repository-created": { "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/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 repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -95977,7 +96152,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -95990,8 +96165,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -95999,11 +96175,11 @@ } } }, - "repository-archived": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96070,7 +96246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -96093,13 +96269,12 @@ } } }, - "repository-created": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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/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/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -96164,7 +96339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -96177,21 +96352,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-deleted": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96258,7 +96430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -96281,12 +96453,12 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-import": { "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/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 a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/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/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -96351,7 +96523,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -96364,18 +96536,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository_import", "supported-webhook-types": [ - "app" + "repository", + "organization" ] } } }, - "repository-edited": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96442,7 +96615,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -96465,102 +96638,11 @@ } } }, - "repository-import": { - "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/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/rest/migrations/source-imports).", - "operationId": "repository-import", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" - }, - "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-repository-import" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_import", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-privatized": { + "repository-publicized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96627,7 +96709,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -96650,11 +96732,11 @@ } } }, - "repository-publicized": { + "repository-renamed": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96721,7 +96803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -96744,13 +96826,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -96815,7 +96897,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -96828,9 +96910,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96838,11 +96919,11 @@ } } }, - "repository-ruleset-created": { + "repository-ruleset-deleted": { "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96909,7 +96990,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -96931,11 +97012,11 @@ } } }, - "repository-ruleset-deleted": { + "repository-ruleset-edited": { "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -97002,7 +97083,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -97024,13 +97105,13 @@ } } }, - "repository-ruleset-edited": { + "repository-transferred": { "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -97095,7 +97176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -97108,8 +97189,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -97117,11 +97199,11 @@ } } }, - "repository-transferred": { + "repository-unarchived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -97188,7 +97270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -97211,13 +97293,13 @@ } } }, - "repository-unarchived": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -97282,7 +97364,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -97295,21 +97377,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "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 created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97376,7 +97456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -97397,11 +97477,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-reopen": { "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", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97468,7 +97548,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -97489,11 +97569,11 @@ } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-resolve": { "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 marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97560,7 +97640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -97581,13 +97661,13 @@ } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-assigned": { "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", + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -97652,7 +97732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -97665,10 +97745,11 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } @@ -98154,6 +98235,99 @@ } } }, + "secret-scanning-alert-unassigned": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 unassigned.", + "operationId": "secret-scanning-alert/unassigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "secret-scanning-alert-validated": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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.", @@ -102905,6 +103079,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105257,6 +105439,34 @@ "name" ] }, + "actions-cache-retention-limit-for-enterprise": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "actions-cache-storage-limit-for-enterprise": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, "code-security-configuration": { "type": "object", "description": "A code security configuration", @@ -110018,6 +110228,34 @@ "subscribed" ] }, + "actions-cache-retention-limit-for-organization": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "actions-cache-storage-limit-for-organization": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -110185,6 +110423,10 @@ "$ref": "#/components/schemas/budget" }, "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ @@ -116867,6 +117109,70 @@ "project_url" ] }, + "projects-v2-field-single-select-option": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + }, + "projects-v2-field-iteration-configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + }, "projects-v2-item-with-content": { "title": "Projects v2 Item", "description": "An item belonging to a project", @@ -118477,7 +118783,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -119100,7 +119406,7 @@ }, "repository-rule-copilot-code-review": { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -119404,6 +119710,9 @@ }, { "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" } ] }, @@ -121817,98 +122126,6 @@ "url" ] }, - "team-project": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/simple-user" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, "team-repository": { "title": "Team Repository", "description": "A team's access to a repository.", @@ -122586,102 +122803,6 @@ "updated_at" ] }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "project-collaborator-permission": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -122895,6 +123016,34 @@ "updated_at" ] }, + "actions-cache-retention-limit-for-repository": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "actions-cache-storage-limit-for-repository": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, "actions-cache-list": { "title": "Repository actions caches", "description": "Repository actions caches", @@ -125349,6 +125498,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -136801,6 +136951,13 @@ "null" ] }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] + }, "secret-scanning-location": { "type": "object", "properties": { @@ -155943,6 +156100,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -156776,6 +156940,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -275156,6 +275327,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -275345,6 +275554,44 @@ "repository" ] }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", @@ -288246,6 +288493,16 @@ "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } }, + "actions-cache-retention-limit": { + "value": { + "max_cache_retention_days": 80 + } + }, + "actions-cache-storage-limit": { + "value": { + "max_cache_size_gb": 150 + } + }, "enterprise-code-security-configuration-list": { "value": [ { @@ -290724,6 +290981,27 @@ } } }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, "delete-budget": { "value": { "message": "Budget successfully deleted.", @@ -295440,6 +295718,194 @@ } ] }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "projects-v2-field": { "value": { "id": 12345, @@ -295450,21 +295916,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -298221,94 +298705,6 @@ "state": "pending" } }, - "team-project-items": { - "value": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - }, - "team-project": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - }, "team-repository-alternative-response-with-repository-permissions": { "value": { "id": 1296269, @@ -298468,43 +298864,6 @@ } ] }, - "project-column": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - }, - "project-collaborator-permission": { - "value": { - "permission": "admin", - "user": { - "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 - } - } - }, "rate-limit-overview": { "value": { "resources": { @@ -307993,8 +308352,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -311431,7 +311789,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "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-location-list": { @@ -319149,6 +319527,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "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.", @@ -319265,15 +319666,6 @@ "type": "integer" } }, - "project-id": { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -319305,15 +319697,6 @@ ] } }, - "column-id": { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "artifact-name": { "name": "name", "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", 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 82cbd6278..c32493b7b 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 @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -1503,6 +1501,152 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise @@ -5129,6 +5273,152 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -5418,6 +5708,24 @@ paths: url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - name: page_size + description: The number of results per page (max 10). + in: query + schema: + type: integer + default: 10 + - name: scope + description: Filter budgets by scope type. + in: query + schema: + type: string + enum: + - enterprise + - organization + - repository + - cost-center responses: '200': "$ref": "#/components/responses/get_all_budgets" @@ -5605,9 +5913,7 @@ paths: in the budget examples: update-budget: - value: - message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -17780,6 +18086,138 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + required: + - issue_field_id + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for organization @@ -19347,6 +19785,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -21520,180 +21959,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -21948,406 +22213,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - type: string - pattern: "^(?:first|last|after:\\d+)$" - examples: - - last - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - "$ref": "#/components/parameters/project-id" - - 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 - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/simple-user" - examples: - default: - "$ref": "#/components/examples/simple-user-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - type: string - examples: - - write - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-collaborator-permission" - examples: - default: - "$ref": "#/components/examples/project-collaborator-permission" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -22912,6 +22777,156 @@ paths: enabledForGitHubApps: true category: actions subcategory: artifacts + "/repos/{owner}/{repo}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/repos/{owner}/{repo}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository @@ -45006,6 +45021,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -45085,6 +45101,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -45111,14 +45129,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -45136,7 +45166,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -48781,184 +48812,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -54965,6 +54818,130 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -70451,6 +70428,72 @@ webhooks: supported-webhook-types: - repository - organization + secret-scanning-alert-assigned: + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 assigned. + operationId: secret-scanning-alert/assigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-created: post: summary: |- @@ -70794,6 +70837,72 @@ webhooks: - repository - organization - app + secret-scanning-alert-unassigned: + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-validated: post: summary: |- @@ -74207,6 +74316,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -76053,6 +76169,28 @@ components: - html_url - key - name + actions-cache-retention-limit-for-enterprise: + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-enterprise: + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, the maximum + size limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 code-security-configuration: type: object description: A code security configuration @@ -79562,6 +79700,28 @@ components: - reason - url - subscribed + actions-cache-retention-limit-for-organization: + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: For repositories in this organization, the maximum duration, + in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-organization: + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum size limit + for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -79683,6 +79843,10 @@ components: items: "$ref": "#/components/schemas/budget" description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available (maps + to hasNextPage from billing platform) required: - budgets get-budget: @@ -84759,6 +84923,55 @@ components: - created_at - updated_at - project_url + projects-v2-field-single-select-option: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + projects-v2-field-iteration-configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. Individual iterations + can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. projects-v2-item-with-content: title: Projects v2 Item description: An item belonging to a project @@ -85973,7 +86186,8 @@ components: automatic_copilot_code_review_enabled: type: boolean description: Request Copilot code review for new pull requests automatically - if the author has access to Copilot code review. + if the author has access to Copilot code review and their premium + requests quota has not reached the limit. dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -86451,7 +86665,8 @@ components: repository-rule-copilot-code-review: title: copilot_code_review description: Request Copilot code review for new pull requests automatically - if the author has access to Copilot code review. + if the author has access to Copilot code review and their premium requests + quota has not reached the limit. type: object required: - type @@ -86624,6 +86839,7 @@ components: - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" rule-suites: title: Rule Suites description: Response @@ -88403,75 +88619,6 @@ components: - role - state - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: - - string - - 'null' - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions team-repository: title: Team Repository description: A team's access to a repository. @@ -88962,73 +89109,6 @@ components: - watchers_count - created_at - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - examples: - - https://api.github.com/projects/120 - cards_url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - type: integer - examples: - - 42 - node_id: - type: string - examples: - - MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - created_at: - type: string - format: date-time - examples: - - '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - examples: - - '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -89180,6 +89260,26 @@ components: - created_at - expires_at - updated_at + actions-cache-retention-limit-for-repository: + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this repository. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-repository: + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, in gigabytes. + type: integer + examples: + - 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -90943,6 +91043,7 @@ components: - '"chris@ozmm.org"' date: type: string + format: date-time examples: - '"2007-10-29T02:42:39.000-07:00"' verification: @@ -99037,6 +99138,12 @@ components: type: - string - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: + - string + - 'null' secret-scanning-location: type: object properties: @@ -113207,6 +113314,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113835,6 +113947,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -201843,6 +201960,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -201974,6 +202117,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -212219,6 +212388,12 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 enterprise-code-security-configuration-list: value: - id: 17 @@ -214376,6 +214551,22 @@ components: alert_recipients: - mona - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -218313,6 +218504,138 @@ components: duration: 14 created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' projects-v2-field: value: id: 12345 @@ -218322,17 +218645,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -220714,84 +221049,6 @@ components: url: https://api.github.com/teams/1/memberships/octocat role: member state: pending - team-project-items: - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - team-project: - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false team-repository-alternative-response-with-repository-permissions: value: id: 1296269 @@ -220940,38 +221197,6 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core - project-column: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - project-collaborator-permission: - value: - permission: admin - user: - 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 rate-limit-overview: value: resources: @@ -229043,7 +229268,6 @@ components: metadata: read contents: read issues: write - single_file: write events: - push - pull_request @@ -232098,6 +232322,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + 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-location-list: value: - type: commit @@ -238814,6 +239057,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert @@ -238915,13 +239177,6 @@ components: required: true schema: type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -238951,13 +239206,6 @@ components: enum: - enable_all - disable_all - column-id: - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 3ecb3bccc..cacf3ecd2 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -2169,6 +2165,206 @@ } } }, + "/enterprises/{enterprise}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an enterprise", + "description": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an enterprise", + "description": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an enterprise", + "description": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an enterprise", + "description": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/enterprises/{enterprise}/code-security/configurations": { "get": { "summary": "Get code security configurations for an enterprise", @@ -7327,6 +7523,206 @@ } } }, + "/organizations/{org}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an organization", + "description": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an organization", + "description": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/organizations/{org}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an organization", + "description": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an organization", + "description": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -7689,6 +8085,35 @@ "parameters": [ { "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "name": "page_size", + "description": "The number of results per page (max 10).", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost-center" + ] + } } ], "responses": { @@ -7937,10 +8362,7 @@ }, "examples": { "update-budget": { - "value": { - "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" - } + "$ref": "#/components/examples/update-budget" } } } @@ -24569,50 +24991,182 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for organization", - "description": "Get a specific field for an organization-owned project.", + }, + "post": { + "summary": "Add a field to an organization-owned project.", + "description": "Add a field to an organization-owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-org", + "operationId": "projects/add-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { "$ref": "#/components/parameters/project-number" }, - { - "$ref": "#/components/parameters/field-id" - }, { "$ref": "#/components/parameters/org" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "issue_field_id": { + "type": "integer", + "description": "The ID of the IssueField to create the field for." + } + }, + "required": [ + "issue_field_id" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Response for adding a field to an organization-owned project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-v2-field" }, "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field" + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "304": { @@ -24623,6 +25177,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -24633,62 +25190,27 @@ } } }, - "/orgs/{org}/projectsV2/{project_number}/items": { + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { "get": { - "summary": "List items for an organization owned project", - "description": "List all items for a specific organization-owned project accessible by the authenticated user.", + "summary": "Get project field for organization", + "description": "Get a specific field for an organization-owned project.", "tags": [ "projects" ], - "operationId": "projects/list-items-for-org", + "operationId": "projects/get-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project" + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" }, "parameters": [ { "$ref": "#/components/parameters/project-number" }, { - "$ref": "#/components/parameters/org" - }, - { - "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.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "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": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "maxItems": 50, - "items": { - "type": "string" - } - } - ] - } - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" + "$ref": "#/components/parameters/field-id" }, { - "$ref": "#/components/parameters/per-page" + "$ref": "#/components/parameters/org" } ], "responses": { @@ -24697,14 +25219,11 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-item-with-content" - } + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { "default": { - "$ref": "#/components/examples/projects-v2-item-with-content" + "$ref": "#/components/examples/projects-v2-field" } } } @@ -24729,119 +25248,21 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "items" - } - }, - "post": { - "summary": "Add item to organization owned project", - "description": "Add an issue or pull request item to the specified organization owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/add-item-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/project-number" - } - ], - "requestBody": { - "required": true, - "description": "Details of the item to add to the project.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "Issue", - "PullRequest" - ], - "description": "The type of item to add to the project. Must be either Issue or PullRequest." - }, - "id": { - "type": "integer", - "description": "The numeric ID of the issue or pull request to add to the project." - } - }, - "required": [ - "type", - "id" - ] - }, - "examples": { - "issue": { - "value": { - "type": "Issue", - "id": 3 - } - }, - "pull_request": { - "value": { - "type": "PullRequest", - "id": 3 - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2-item-simple" - }, - "examples": { - "issue": { - "$ref": "#/components/examples/projects-v2-item-simple" - }, - "pull_request": { - "$ref": "#/components/examples/projects-v2-item-simple" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "items" + "subcategory": "fields" } } }, - "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + "/orgs/{org}/projectsV2/{project_number}/items": { "get": { - "summary": "Get an item for an organization owned project", - "description": "Get a specific item from an organization-owned project.", + "summary": "List items for an organization owned project", + "description": "List all items for a specific organization-owned project accessible by the authenticated user.", "tags": [ "projects" ], - "operationId": "projects/get-org-item", + "operationId": "projects/list-items-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project" + "url": "https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project" }, "parameters": [ { @@ -24851,11 +25272,17 @@ "$ref": "#/components/parameters/org" }, { - "$ref": "#/components/parameters/item-id" + "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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } }, { "name": "fields", - "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", + "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": { @@ -24872,6 +25299,15 @@ } ] } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/per-page" } ], "responses": { @@ -24880,7 +25316,190 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/projects-v2-item-with-content" + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-item-with-content" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-item-with-content" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + }, + "post": { + "summary": "Add item to organization owned project", + "description": "Add an issue or pull request item to the specified organization owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/add-item-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/project-number" + } + ], + "requestBody": { + "required": true, + "description": "Details of the item to add to the project.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Issue", + "PullRequest" + ], + "description": "The type of item to add to the project. Must be either Issue or PullRequest." + }, + "id": { + "type": "integer", + "description": "The numeric ID of the issue or pull request to add to the project." + } + }, + "required": [ + "type", + "id" + ] + }, + "examples": { + "issue": { + "value": { + "type": "Issue", + "id": 3 + } + }, + "pull_request": { + "value": { + "type": "PullRequest", + "id": 3 + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-simple" + }, + "examples": { + "issue": { + "$ref": "#/components/examples/projects-v2-item-simple" + }, + "pull_request": { + "$ref": "#/components/examples/projects-v2-item-simple" + } + } + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "items" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + "get": { + "summary": "Get an item for an organization owned project", + "description": "Get a specific item from an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-org-item", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$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.\n\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789", + "in": "query", + "required": false, + "schema": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "maxItems": 50, + "items": { + "type": "string" + } + } + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2-item-with-content" }, "examples": { "default": { @@ -26799,6 +27418,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -29791,254 +30413,6 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { - "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "$ref": "#/components/parameters/org" - }, - { - "$ref": "#/components/parameters/team-slug" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/orgs/{org}/teams/{team_slug}/repos": { "get": { "summary": "List team repositories", @@ -30379,563 +30753,6 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-column" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-column" - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "$ref": "#/components/parameters/column-id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed_simple" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/simple-user" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/simple-user-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "type": "string", - "examples": [ - "write" - ] - } - } - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-id" - }, - { - "$ref": "#/components/parameters/username" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-collaborator-permission" - }, - "examples": { - "default": { - "$ref": "#/components/examples/project-collaborator-permission" - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", @@ -31602,6 +31419,218 @@ } } }, + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for a repository", + "description": "Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for a repository", + "description": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-retention-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for a repository", + "description": "Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + }, + "examples": { + "default": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for a repository", + "description": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + }, + "examples": { + "selected_actions": { + "$ref": "#/components/examples/actions-cache-storage-limit" + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/repos/{owner}/{repo}/actions/cache/usage": { "get": { "summary": "Get GitHub Actions cache usage for a repository", @@ -62081,6 +62110,9 @@ { "$ref": "#/components/parameters/secret-scanning-alert-resolution" }, + { + "$ref": "#/components/parameters/secret-scanning-alert-assignee" + }, { "$ref": "#/components/parameters/secret-scanning-alert-sort" }, @@ -62207,7 +62239,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -62242,6 +62274,9 @@ }, "resolution_comment": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + }, + "assignee": { + "$ref": "#/components/schemas/secret-scanning-alert-assignee" } }, "anyOf": [ @@ -62249,6 +62284,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -62258,6 +62298,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -62286,7 +62338,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "$ref": "#/components/responses/service_unavailable" @@ -67201,254 +67253,6 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { - "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/list-projects-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/page" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/team-project" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project-items" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/team-project" - }, - "examples": { - "default": { - "$ref": "#/components/examples/team-project" - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "$ref": "#/components/parameters/team-id" - }, - { - "$ref": "#/components/parameters/project-id" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, "/teams/{team_id}/repos": { "get": { "summary": "List team repositories (Legacy)", @@ -75787,120 +75591,301 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "projects", - "subcategory": "projects" + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}": { + "get": { + "summary": "Get project for user", + "description": "Get a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/projects-v2" + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "projects" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields": { + "get": { + "summary": "List project fields for user", + "description": "List all fields for a specific user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/list-fields-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/project-number" + }, + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/projects-v2-field" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/projects-v2-field-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "projects", + "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}": { - "get": { - "summary": "Get project for user", - "description": "Get a specific user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/projects#get-project-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "$ref": "#/components/parameters/project-number" + "$ref": "#/components/parameters/username" }, { - "$ref": "#/components/parameters/username" + "$ref": "#/components/parameters/project-number" } ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/projects-v2" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } }, - "examples": { - "default": { - "$ref": "#/components/examples/projects-v2" + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select-request" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration-request" } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } - }, - "304": { - "$ref": "#/components/responses/not_modified" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects", - "subcategory": "projects" - } - } - }, - "/users/{username}/projectsV2/{project_number}/fields": { - "get": { - "summary": "List project fields for user", - "description": "List all fields for a specific user-owned project.", - "tags": [ - "projects" - ], - "operationId": "projects/list-fields-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#list-project-fields-for-user" - }, - "parameters": [ - { - "$ref": "#/components/parameters/project-number" - }, - { - "$ref": "#/components/parameters/username" - }, - { - "$ref": "#/components/parameters/per-page" - }, - { - "$ref": "#/components/parameters/pagination-before" - }, - { - "$ref": "#/components/parameters/pagination-after" - } - ], "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/projects-v2-field" - } + "$ref": "#/components/schemas/projects-v2-field" }, "examples": { - "default": { - "$ref": "#/components/examples/projects-v2-field-items" + "text_field": { + "$ref": "#/components/examples/projects-v2-field-text" + }, + "number_field": { + "$ref": "#/components/examples/projects-v2-field-number" + }, + "date_field": { + "$ref": "#/components/examples/projects-v2-field-date" + }, + "single_select_field": { + "$ref": "#/components/examples/projects-v2-field-single-select" + }, + "iteration_field": { + "$ref": "#/components/examples/projects-v2-field-iteration" } } } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } } }, "304": { @@ -75911,6 +75896,9 @@ }, "401": { "$ref": "#/components/responses/requires_authentication" + }, + "422": { + "$ref": "#/components/responses/validation_failed" } }, "x-github": { @@ -87612,7 +87600,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-milestone-closed" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "milestone", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "milestone-created": { + "post": { + "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", + "description": "A milestone was created.", + "operationId": "milestone/created", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + }, + "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-milestone-created" } } } @@ -87634,11 +87715,11 @@ } } }, - "milestone-created": { + "milestone-deleted": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was created.", - "operationId": "milestone/created", + "description": "A milestone was deleted.", + "operationId": "milestone/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -87705,7 +87786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-milestone-deleted" } } } @@ -87727,11 +87808,11 @@ } } }, - "milestone-deleted": { + "milestone-edited": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was deleted.", - "operationId": "milestone/deleted", + "description": "A milestone was edited.", + "operationId": "milestone/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -87798,7 +87879,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-milestone-edited" } } } @@ -87820,11 +87901,11 @@ } } }, - "milestone-edited": { + "milestone-opened": { "post": { "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was edited.", - "operationId": "milestone/edited", + "description": "A milestone was opened.", + "operationId": "milestone/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" }, @@ -87891,7 +87972,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-milestone-opened" } } } @@ -87913,13 +87994,13 @@ } } }, - "milestone-opened": { + "org-block-blocked": { "post": { - "summary": "This event occurs when there is activity relating to milestones. For more information, see \"[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones).\" For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/rest/issues/milestones)\" in the REST API documentation.\n\nIf you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" or \"Pull requests\" repository permissions.", - "description": "A milestone was opened.", - "operationId": "milestone/opened", + "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", + "description": "A user was blocked from the organization.", + "operationId": "org-block/blocked", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#milestone" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { @@ -87984,7 +88065,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-org-block-blocked" } } } @@ -87997,20 +88078,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "milestone", + "subcategory": "org_block", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "org-block-blocked": { + "org-block-unblocked": { "post": { "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A user was blocked from the organization.", - "operationId": "org-block/blocked", + "description": "A previously blocked user was unblocked from the organization.", + "operationId": "org-block/unblocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" }, @@ -88077,7 +88158,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } @@ -88099,13 +88180,13 @@ } } }, - "org-block-unblocked": { + "organization-deleted": { "post": { - "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", - "description": "A previously blocked user was unblocked from the organization.", - "operationId": "org-block/unblocked", + "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#org_block" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { @@ -88170,7 +88251,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-organization-deleted" } } } @@ -88183,7 +88264,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "org_block", + "subcategory": "organization", "supported-webhook-types": [ "organization", "business", @@ -88192,11 +88273,11 @@ } } }, - "organization-deleted": { + "organization-member-added": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "A member accepted an invitation to join an organization.", + "operationId": "organization/member-added", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88263,7 +88344,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-organization-member-added" } } } @@ -88285,11 +88366,11 @@ } } }, - "organization-member-added": { + "organization-member-invited": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "A member was invited to join the organization.", + "operationId": "organization/member-invited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88356,7 +88437,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-organization-member-invited" } } } @@ -88378,11 +88459,11 @@ } } }, - "organization-member-invited": { + "organization-member-removed": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "A member was removed from the organization.", + "operationId": "organization/member-removed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88449,7 +88530,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-organization-member-removed" } } } @@ -88471,11 +88552,11 @@ } } }, - "organization-member-removed": { + "organization-renamed": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "description": "The name of an organization was changed.", + "operationId": "organization/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#organization" }, @@ -88542,7 +88623,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-organization-renamed" } } } @@ -88564,13 +88645,13 @@ } } }, - "organization-renamed": { + "package-published": { "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/organizations/collaborating-with-groups-in-organizations/about-organizations).\" For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/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", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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/webhooks/webhook-events-and-payloads#organization" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { @@ -88635,7 +88716,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-package-published" } } } @@ -88648,20 +88729,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "organization", + "subcategory": "package", "supported-webhook-types": [ + "repository", "organization", - "business", "app" ] } } }, - "package-published": { + "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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", + "description": "A previously published package was updated.", + "operationId": "package/updated", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#package" }, @@ -88728,7 +88809,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-package-updated" } } } @@ -88750,13 +88831,12 @@ } } }, - "package-updated": { + "page-build": { "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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 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/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/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/webhooks/webhook-events-and-payloads#package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { @@ -88821,7 +88901,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-page-build" } } } @@ -88834,7 +88914,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "package", + "subcategory": "page_build", "supported-webhook-types": [ "repository", "organization", @@ -88843,12 +88923,13 @@ } } }, - "page-build": { + "personal-access-token-request-approved": { "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/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/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 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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#page_build" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { @@ -88860,9 +88941,9 @@ } }, { - "name": "X-Github-Hook-Id", + "name": "X-GitHub-Delivery", "in": "header", - "example": 12312312, + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" } @@ -88870,7 +88951,15 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, "schema": { "type": "string" } @@ -88886,7 +88975,59 @@ { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", - "example": "repository", + "example": "integration", + "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-personal-access-token-request-approved" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "personal_access_token_request", + "supported-webhook-types": [ + "app", + "organization" + ] + } + } + }, + "personal-access-token-request-cancelled": { + "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/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/webhooks/webhook-events-and-payloads#personal_access_token_request" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" } @@ -88899,6 +89040,38 @@ "type": "string" } }, + { + "name": "X-Github-Event", + "in": "header", + "example": "personal_access_token_request", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "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": "integration", + "schema": { + "type": "string" + } + }, { "name": "X-Hub-Signature-256", "in": "header", @@ -88913,7 +89086,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } @@ -88926,20 +89099,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "page_build", + "subcategory": "personal_access_token_request", "supported-webhook-types": [ - "repository", - "organization", - "app" + "app", + "organization" ] } } }, - "personal-access-token-request-approved": { + "personal-access-token-request-created": { "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/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", + "description": "A fine-grained personal access token request was created.", + "operationId": "personal-access-token-request/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -89006,7 +89178,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } @@ -89027,11 +89199,11 @@ } } }, - "personal-access-token-request-cancelled": { + "personal-access-token-request-denied": { "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/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", + "description": "A fine-grained personal access token request was denied.", + "operationId": "personal-access-token-request/denied", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" }, @@ -89098,7 +89270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } @@ -89119,13 +89291,12 @@ } } }, - "personal-access-token-request-created": { + "ping": { "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/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 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/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { @@ -89137,9 +89308,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -89147,31 +89318,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" } @@ -89190,7 +89361,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$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" + } } } } @@ -89202,22 +89388,26 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "ping", "supported-webhook-types": [ + "repository", + "organization", "app", - "organization" + "business", + "marketplace" ] } } }, - "personal-access-token-request-denied": { + "project-card-converted": { "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/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", + "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -89229,9 +89419,9 @@ } }, { - "name": "X-GitHub-Delivery", + "name": "X-Github-Hook-Id", "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "example": 12312312, "schema": { "type": "string" } @@ -89239,31 +89429,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" } @@ -89282,7 +89472,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-project-card-converted" } } } @@ -89295,20 +89485,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "personal_access_token_request", + "subcategory": "project_card", "supported-webhook-types": [ - "app", - "organization" + "repository", + "organization", + "app" ] } } }, - "ping": { + "project-card-created": { "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 card on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#ping" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { @@ -89373,22 +89565,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-project-card-created" } } } @@ -89400,24 +89577,21 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "ping", + "subcategory": "project_card", "supported-webhook-types": [ "repository", "organization", - "app", - "business", - "marketplace" + "app" ] } } }, - "project-card-converted": { + "project-card-deleted": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A card on a project (classic) was deleted.", + "operationId": "project-card/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -89484,7 +89658,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-project-card-deleted" } } } @@ -89506,11 +89680,11 @@ } } }, - "project-card-created": { + "project-card-edited": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A note on a project (classic) was edited.", + "operationId": "project-card/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_card" }, @@ -89577,7 +89751,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-project-card-edited" } } } @@ -89599,11 +89773,11 @@ } } }, - "project-card-deleted": { + "project-card-moved": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#project_card" }, @@ -89670,7 +89844,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-project-card-moved" } } } @@ -89692,13 +89866,13 @@ } } }, - "project-card-edited": { + "project-closed": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 there is activity relating to a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -89763,7 +89937,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-project-closed" } } } @@ -89776,7 +89950,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -89785,13 +89959,13 @@ } } }, - "project-card-moved": { + "project-column-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_card" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -89856,7 +90030,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-project-column-created" } } } @@ -89869,7 +90043,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_card", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -89878,13 +90052,13 @@ } } }, - "project-closed": { + "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 column on a project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { @@ -89949,7 +90123,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-project-column-deleted" } } } @@ -89962,7 +90136,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project", + "subcategory": "project_column", "supported-webhook-types": [ "repository", "organization", @@ -89971,11 +90145,11 @@ } } }, - "project-column-created": { + "project-column-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "The name of a column on a project (classic) was changed.", + "operationId": "project-column/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -90042,7 +90216,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-project-column-edited" } } } @@ -90064,11 +90238,11 @@ } } }, - "project-column-deleted": { + "project-column-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A column was moved to a new position on a project (classic).", + "operationId": "project-column/moved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project_column" }, @@ -90135,7 +90309,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-column-moved" } } } @@ -90157,13 +90331,13 @@ } } }, - "project-column-edited": { + "project-created": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 project (classic). For more information, see \"[About projects (classic)](https://docs.github.com/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -90228,7 +90402,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-created" } } } @@ -90241,7 +90415,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -90250,13 +90424,13 @@ } } }, - "project-column-moved": { + "project-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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/webhooks/webhook-events-and-payloads#project_column" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { @@ -90321,7 +90495,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-deleted" } } } @@ -90334,7 +90508,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "project_column", + "subcategory": "project", "supported-webhook-types": [ "repository", "organization", @@ -90343,11 +90517,11 @@ } } }, - "project-created": { + "project-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "The name or description of a project (classic) was changed.", + "operationId": "project/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -90414,7 +90588,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-edited" } } } @@ -90436,11 +90610,11 @@ } } }, - "project-deleted": { + "project-reopened": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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", + "description": "A project (classic) was closed.", + "operationId": "project/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#project" }, @@ -90507,7 +90681,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-reopened" } } } @@ -90529,13 +90703,13 @@ } } }, - "project-edited": { + "projects-v2-closed": { "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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -90557,7 +90731,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -90600,7 +90774,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" } } } @@ -90612,23 +90786,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "project-reopened": { + "projects-v2-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/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/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/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 an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#project" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -90650,7 +90823,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "issues", + "example": "project-v2", "schema": { "type": "string" } @@ -90693,7 +90866,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" } } } @@ -90705,21 +90878,20 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "project", + "subcategory": "projects_v2", "supported-webhook-types": [ - "repository", - "organization", - "app" + "organization" ] } } }, - "projects-v2-closed": { + "projects-v2-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/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/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", + "description": "A project in the organization was deleted.", + "operationId": "projects-v2/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -90786,7 +90958,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" } } } @@ -90807,11 +90979,11 @@ } } }, - "projects-v2-created": { + "projects-v2-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/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/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", + "description": "The title, description, or README of a project in the organization was changed.", + "operationId": "projects-v2/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, @@ -90878,7 +91050,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" } } } @@ -90899,13 +91071,13 @@ } } }, - "projects-v2-deleted": { + "projects-v2-item-archived": { "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/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/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 an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/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/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -90927,7 +91099,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -90970,7 +91142,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" } } } @@ -90984,20 +91156,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-edited": { + "projects-v2-item-converted": { "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/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/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 an item on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { @@ -91019,7 +91191,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-item", "schema": { "type": "string" } @@ -91062,7 +91234,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" } } } @@ -91076,18 +91248,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_item", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-archived": { + "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/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/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/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/archived", + "description": "An item was added to a project in the organization.", + "operationId": "projects-v2-item/created", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91154,7 +91326,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" } } } @@ -91175,11 +91347,11 @@ } } }, - "projects-v2-item-converted": { + "projects-v2-item-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/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/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", + "description": "An item was deleted from a project in the organization.", + "operationId": "projects-v2-item/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91246,7 +91418,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" } } } @@ -91267,11 +91439,11 @@ } } }, - "projects-v2-item-created": { + "projects-v2-item-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/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/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", + "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/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91338,7 +91510,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" } } } @@ -91359,11 +91531,11 @@ } } }, - "projects-v2-item-deleted": { + "projects-v2-item-reordered": { "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/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/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", + "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/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91430,7 +91602,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" } } } @@ -91451,11 +91623,11 @@ } } }, - "projects-v2-item-edited": { + "projects-v2-item-restored": { "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/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/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 archived item on an organization project was restored from the archive. For more information, see \"[Archiving items from your project](https://docs.github.com/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/webhooks/webhook-events-and-payloads#projects_v2_item" }, @@ -91522,7 +91694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" } } } @@ -91543,13 +91715,13 @@ } } }, - "projects-v2-item-reordered": { + "projects-v2-reopened": { "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/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/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", + "summary": "This event occurs when there is activity relating to an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { @@ -91571,7 +91743,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2", "schema": { "type": "string" } @@ -91614,7 +91786,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" } } } @@ -91628,20 +91800,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-item-restored": { + "projects-v2-status-update-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/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/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/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project).\"", - "operationId": "projects-v2-item/restored", + "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/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/webhooks/webhook-events-and-payloads#projects_v2_item" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -91663,7 +91835,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-item", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -91706,7 +91878,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" } } } @@ -91720,20 +91892,20 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_item", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-reopened": { + "projects-v2-status-update-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/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/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 a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/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/webhooks/webhook-events-and-payloads#projects_v2" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { @@ -91755,7 +91927,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2", + "example": "project-v2-status-update", "schema": { "type": "string" } @@ -91798,7 +91970,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" } } } @@ -91812,18 +91984,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2", + "subcategory": "projects_v2_status_update", "supported-webhook-types": [ "organization" ] } } }, - "projects-v2-status-update-created": { + "projects-v2-status-update-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/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", + "description": "A status update was edited on a project in the organization.", + "operationId": "projects-v2-status-update/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, @@ -91890,7 +92062,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" } } } @@ -91911,13 +92083,12 @@ } } }, - "projects-v2-status-update-deleted": { + "public": { "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/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 repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/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/webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { @@ -91939,7 +92110,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "issues", "schema": { "type": "string" } @@ -91982,7 +92153,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-public" } } } @@ -91994,22 +92165,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "public", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "projects-v2-status-update-edited": { + "pull-request-assigned": { "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/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -92031,7 +92203,7 @@ { "name": "X-Github-Event", "in": "header", - "example": "project-v2-status-update", + "example": "issues", "schema": { "type": "string" } @@ -92074,7 +92246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-pull-request-assigned" } } } @@ -92086,21 +92258,23 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "projects_v2_status_update", + "subcategory": "pull_request", "supported-webhook-types": [ - "organization" + "repository", + "organization", + "app" ] } } }, - "public": { + "pull-request-auto-merge-disabled": { "post": { - "summary": "This event occurs when repository visibility changes from private to public. For more information, see \"[Setting repository visibility](https://docs.github.com/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#public" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -92165,7 +92339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" } } } @@ -92178,7 +92352,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "public", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -92187,11 +92361,11 @@ } } }, - "pull-request-assigned": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", + "description": "Auto merge was enabled for a pull request. For more information, see \"[Automatically merging a pull request](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92258,7 +92432,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" } } } @@ -92280,11 +92454,11 @@ } } }, - "pull-request-auto-merge-disabled": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-disabled", + "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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92351,7 +92525,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-pull-request-closed" } } } @@ -92373,11 +92547,11 @@ } } }, - "pull-request-auto-merge-enabled": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request).\"", - "operationId": "pull-request/auto-merge-enabled", + "description": "A pull request was converted to a draft. For more information, see \"[Changing the stage of a pull request](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92444,7 +92618,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" } } } @@ -92466,11 +92640,11 @@ } } }, - "pull-request-closed": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", + "description": "A pull request was removed from a milestone.", + "operationId": "pull-request/demilestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92537,7 +92711,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" } } } @@ -92559,11 +92733,11 @@ } } }, - "pull-request-converted-to-draft": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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 removed from the merge queue.", + "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92630,7 +92804,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } @@ -92652,11 +92826,11 @@ } } }, - "pull-request-demilestoned": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92723,7 +92897,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-pull-request-edited" } } } @@ -92745,11 +92919,11 @@ } } }, - "pull-request-dequeued": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "A pull request was added to the merge queue.", + "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92816,7 +92990,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-dequeued" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } @@ -92838,11 +93012,11 @@ } } }, - "pull-request-edited": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 label was added to a pull request.", + "operationId": "pull-request/labeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -92909,7 +93083,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-pull-request-labeled" } } } @@ -92931,11 +93105,11 @@ } } }, - "pull-request-enqueued": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "Conversation on a pull request was locked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93002,7 +93176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-pull-request-locked" } } } @@ -93024,11 +93198,11 @@ } } }, - "pull-request-labeled": { + "pull-request-milestoned": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 added to a milestone.", + "operationId": "pull-request/milestoned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93095,7 +93269,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" } } } @@ -93117,11 +93291,11 @@ } } }, - "pull-request-locked": { + "pull-request-opened": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/locked", + "description": "A pull request was created", + "operationId": "pull-request/opened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93188,7 +93362,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-opened" } } } @@ -93210,11 +93384,11 @@ } } }, - "pull-request-milestoned": { + "pull-request-ready-for-review": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "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/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/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93281,7 +93455,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" } } } @@ -93303,11 +93477,11 @@ } } }, - "pull-request-opened": { + "pull-request-reopened": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 previously closed pull request was reopened.", + "operationId": "pull-request/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -93374,7 +93548,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-reopened" } } } @@ -93396,13 +93570,13 @@ } } }, - "pull-request-ready-for-review": { + "pull-request-review-comment-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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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", + "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -93467,7 +93641,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" } } } @@ -93480,7 +93654,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -93489,13 +93663,13 @@ } } }, - "pull-request-reopened": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", + "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { @@ -93560,7 +93734,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" } } } @@ -93573,7 +93747,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_comment", "supported-webhook-types": [ "repository", "organization", @@ -93582,11 +93756,11 @@ } } }, - "pull-request-review-comment-created": { + "pull-request-review-comment-edited": { "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, @@ -93653,7 +93827,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" } } } @@ -93675,13 +93849,13 @@ } } }, - "pull-request-review-comment-deleted": { + "pull-request-review-dismissed": { "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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 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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -93746,7 +93920,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" } } } @@ -93759,7 +93933,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -93768,13 +93942,13 @@ } } }, - "pull-request-review-comment-edited": { + "pull-request-review-edited": { "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/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/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/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 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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request_review_comment" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { @@ -93839,7 +94013,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" } } } @@ -93852,7 +94026,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_comment", + "subcategory": "pull_request_review", "supported-webhook-types": [ "repository", "organization", @@ -93861,13 +94035,13 @@ } } }, - "pull-request-review-dismissed": { + "pull-request-review-request-removed": { "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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -93932,7 +94106,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" } } } @@ -93945,7 +94119,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -93954,11 +94128,104 @@ } } }, - "pull-request-review-edited": { + "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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/webhooks/webhook-events-and-payloads#pull_request" + }, + "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-requested" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "pull_request", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "pull-request-review-submitted": { "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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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", + "description": "A review on a pull request was submitted.", + "operationId": "pull-request-review/submitted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review" }, @@ -94025,7 +94292,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" } } } @@ -94047,106 +94314,13 @@ } } }, - "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/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" - }, - "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-request-removed" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "pull_request", - "supported-webhook-types": [ - "repository", - "organization", - "app" - ] - } - } - }, - "pull-request-review-requested": { + "pull-request-review-thread-resolved": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/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 comment thread on a pull request. For more information, see \"[About pull request reviews](https://docs.github.com/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -94211,7 +94385,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" } } } @@ -94224,7 +94398,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -94233,13 +94407,13 @@ } } }, - "pull-request-review-submitted": { + "pull-request-review-thread-unresolved": { "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/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/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/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", + "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/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request_review" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { @@ -94304,7 +94478,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" } } } @@ -94317,7 +94491,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review", + "subcategory": "pull_request_review_thread", "supported-webhook-types": [ "repository", "organization", @@ -94326,13 +94500,13 @@ } } }, - "pull-request-review-thread-resolved": { + "pull-request-synchronize": { "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/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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", + "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -94397,7 +94571,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" } } } @@ -94410,7 +94584,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -94419,13 +94593,13 @@ } } }, - "pull-request-review-thread-unresolved": { + "pull-request-unassigned": { "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/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/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/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 on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request_review_thread" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { @@ -94490,7 +94664,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" } } } @@ -94503,7 +94677,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request_review_thread", + "subcategory": "pull_request", "supported-webhook-types": [ "repository", "organization", @@ -94512,11 +94686,11 @@ } } }, - "pull-request-synchronize": { + "pull-request-unlabeled": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 label was removed from a pull request.", + "operationId": "pull-request/unlabeled", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94583,7 +94757,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" } } } @@ -94605,11 +94779,11 @@ } } }, - "pull-request-unassigned": { + "pull-request-unlocked": { "post": { "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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": "Conversation on a pull request was unlocked. For more information, see \"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations).\"", + "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request" }, @@ -94676,7 +94850,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" } } } @@ -94698,13 +94872,12 @@ } } }, - "pull-request-unlabeled": { + "push": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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 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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { @@ -94769,7 +94942,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-push" } } } @@ -94782,7 +94955,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "push", "supported-webhook-types": [ "repository", "organization", @@ -94791,13 +94964,13 @@ } } }, - "pull-request-unlocked": { + "registry-package-published": { "post": { - "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/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/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/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/communities/moderating-comments-and-conversations/locking-conversations).\"", - "operationId": "pull-request/unlocked", + "summary": "This event occurs when there is activity relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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/webhooks/webhook-events-and-payloads#pull_request" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -94862,7 +95035,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-registry-package-published" } } } @@ -94875,7 +95048,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "pull_request", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -94884,12 +95057,13 @@ } } }, - "push": { + "registry-package-updated": { "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 relating to GitHub Packages. For more information, see \"[Introduction to GitHub Packages](https://docs.github.com/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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/webhooks/webhook-events-and-payloads#push" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { @@ -94954,7 +95128,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-registry-package-updated" } } } @@ -94967,7 +95141,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "push", + "subcategory": "registry_package", "supported-webhook-types": [ "repository", "organization", @@ -94976,13 +95150,13 @@ } } }, - "registry-package-published": { + "release-created": { "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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 relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -95047,7 +95221,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-release-created" } } } @@ -95060,7 +95234,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -95069,13 +95243,13 @@ } } }, - "registry-package-updated": { + "release-deleted": { "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/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/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/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 relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { @@ -95140,7 +95314,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-release-deleted" } } } @@ -95153,7 +95327,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "registry_package", + "subcategory": "release", "supported-webhook-types": [ "repository", "organization", @@ -95162,11 +95336,11 @@ } } }, - "release-created": { + "release-edited": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", + "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95233,7 +95407,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-release-edited" } } } @@ -95255,11 +95429,11 @@ } } }, - "release-deleted": { + "release-prereleased": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/webhooks/webhook-events-and-payloads#release" }, @@ -95326,7 +95500,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-release-prereleased" } } } @@ -95348,11 +95522,11 @@ } } }, - "release-edited": { + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", - "operationId": "release/edited", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95419,7 +95593,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -95441,11 +95615,11 @@ } } }, - "release-prereleased": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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 was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95512,7 +95686,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -95534,11 +95708,11 @@ } } }, - "release-published": { + "release-unpublished": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#release" }, @@ -95605,7 +95779,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -95627,13 +95801,13 @@ } } }, - "release-released": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/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/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -95698,7 +95872,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -95711,7 +95885,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -95720,13 +95894,13 @@ } } }, - "release-unpublished": { + "repository-advisory-reported": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/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", + "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/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/webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -95791,7 +95965,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -95804,7 +95978,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -95813,13 +95987,13 @@ } } }, - "repository-advisory-published": { + "repository-archived": { "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/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 repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -95884,7 +96058,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -95897,8 +96071,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -95906,13 +96081,13 @@ } } }, - "repository-advisory-reported": { + "repository-created": { "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/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 repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -95977,7 +96152,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -95990,8 +96165,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -95999,11 +96175,11 @@ } } }, - "repository-archived": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96070,7 +96246,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-deleted" } } } @@ -96093,13 +96269,12 @@ } } }, - "repository-created": { + "repository-dispatch-sample.collected": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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/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/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { @@ -96164,7 +96339,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" } } } @@ -96177,21 +96352,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_dispatch", "supported-webhook-types": [ - "business", - "repository", - "organization", "app" ] } } }, - "repository-deleted": { + "repository-edited": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96258,7 +96430,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -96281,12 +96453,12 @@ } } }, - "repository-dispatch-sample.collected": { + "repository-import": { "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/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 a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/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/rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -96351,7 +96523,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -96364,18 +96536,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_dispatch", + "subcategory": "repository_import", "supported-webhook-types": [ - "app" + "repository", + "organization" ] } } }, - "repository-edited": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96442,7 +96615,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -96465,102 +96638,11 @@ } } }, - "repository-import": { - "post": { - "summary": "This event occurs when a repository is imported to GitHub. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/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/rest/migrations/source-imports).", - "operationId": "repository-import", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import" - }, - "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-repository-import" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_import", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-privatized": { + "repository-publicized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96627,7 +96709,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -96650,11 +96732,11 @@ } } }, - "repository-publicized": { + "repository-renamed": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -96721,7 +96803,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -96744,13 +96826,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -96815,7 +96897,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -96828,9 +96910,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -96838,11 +96919,11 @@ } } }, - "repository-ruleset-created": { + "repository-ruleset-deleted": { "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -96909,7 +96990,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -96931,11 +97012,11 @@ } } }, - "repository-ruleset-deleted": { + "repository-ruleset-edited": { "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -97002,7 +97083,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -97024,13 +97105,13 @@ } } }, - "repository-ruleset-edited": { + "repository-transferred": { "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/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/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/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", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -97095,7 +97176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -97108,8 +97189,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -97117,11 +97199,11 @@ } } }, - "repository-transferred": { + "repository-unarchived": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" }, @@ -97188,7 +97270,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -97211,13 +97293,13 @@ } } }, - "repository-unarchived": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -97282,7 +97364,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -97295,21 +97377,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "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 created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97376,7 +97456,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -97397,11 +97477,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-reopen": { "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", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97468,7 +97548,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -97489,11 +97569,11 @@ } } }, - "repository-vulnerability-alert-reopen": { + "repository-vulnerability-alert-resolve": { "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 marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -97560,7 +97640,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -97581,13 +97661,13 @@ } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-assigned": { "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", + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 assigned.", + "operationId": "secret-scanning-alert/assigned", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -97652,7 +97732,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } @@ -97665,10 +97745,11 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } @@ -98154,6 +98235,99 @@ } } }, + "secret-scanning-alert-unassigned": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 unassigned.", + "operationId": "secret-scanning-alert/unassigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "secret_scanning_alert", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, "secret-scanning-alert-validated": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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.", @@ -102905,6 +103079,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105257,6 +105439,34 @@ "name" ] }, + "actions-cache-retention-limit-for-enterprise": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "actions-cache-storage-limit-for-enterprise": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, "code-security-configuration": { "type": "object", "description": "A code security configuration", @@ -110018,6 +110228,34 @@ "subscribed" ] }, + "actions-cache-retention-limit-for-organization": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "actions-cache-storage-limit-for-organization": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, "dependabot-repository-access-details": { "title": "Dependabot Repository Access Details", "description": "Information about repositories that Dependabot is able to access in an organization", @@ -110185,6 +110423,10 @@ "$ref": "#/components/schemas/budget" }, "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ @@ -116867,6 +117109,70 @@ "project_url" ] }, + "projects-v2-field-single-select-option": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + }, + "projects-v2-field-iteration-configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + }, "projects-v2-item-with-content": { "title": "Projects v2 Item", "description": "An item belonging to a project", @@ -118477,7 +118783,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -119100,7 +119406,7 @@ }, "repository-rule-copilot-code-review": { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -119404,6 +119710,9 @@ }, { "$ref": "#/components/schemas/repository-rule-code-scanning" + }, + { + "$ref": "#/components/schemas/repository-rule-copilot-code-review" } ] }, @@ -121817,98 +122126,6 @@ "url" ] }, - "team-project": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "$ref": "#/components/schemas/simple-user" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, "team-repository": { "title": "Team Repository", "description": "A team's access to a repository.", @@ -122586,102 +122803,6 @@ "updated_at" ] }, - "project-column": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "project-collaborator-permission": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - } - }, - "required": [ - "permission", - "user" - ] - }, "rate-limit": { "title": "Rate Limit", "type": "object", @@ -122895,6 +123016,34 @@ "updated_at" ] }, + "actions-cache-retention-limit-for-repository": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "actions-cache-storage-limit-for-repository": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, "actions-cache-list": { "title": "Repository actions caches", "description": "Repository actions caches", @@ -125349,6 +125498,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -136801,6 +136951,13 @@ "null" ] }, + "secret-scanning-alert-assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] + }, "secret-scanning-location": { "type": "object", "properties": { @@ -155943,6 +156100,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -156776,6 +156940,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -275156,6 +275327,44 @@ "sender" ] }, + "webhook-secret-scanning-alert-assigned": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", @@ -275345,6 +275554,44 @@ "repository" ] }, + "webhook-secret-scanning-alert-unassigned": { + "title": "secret_scanning_alert unassigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unassigned" + ] + }, + "alert": { + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + }, + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "alert", + "repository" + ] + }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", @@ -288246,6 +288493,16 @@ "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } }, + "actions-cache-retention-limit": { + "value": { + "max_cache_retention_days": 80 + } + }, + "actions-cache-storage-limit": { + "value": { + "max_cache_size_gb": 150 + } + }, "enterprise-code-security-configuration-list": { "value": [ { @@ -290724,6 +290981,27 @@ } } }, + "update-budget": { + "value": { + "message": "Budget successfully updated.", + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } + } + }, "delete-budget": { "value": { "message": "Budget successfully deleted.", @@ -295440,6 +295718,194 @@ } ] }, + "projects-v2-field-single-select-request": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "projects-v2-field-iteration-request": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + }, + "projects-v2-field-text": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "projects-v2-field-number": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "projects-v2-field-date": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "projects-v2-field-single-select": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "projects-v2-field-iteration": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + }, "projects-v2-field": { "value": { "id": 12345, @@ -295450,21 +295916,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -298221,94 +298705,6 @@ "state": "pending" } }, - "team-project-items": { - "value": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - }, - "team-project": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - }, "team-repository-alternative-response-with-repository-permissions": { "value": { "id": 1296269, @@ -298468,43 +298864,6 @@ } ] }, - "project-column": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - }, - "project-collaborator-permission": { - "value": { - "permission": "admin", - "user": { - "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 - } - } - }, "rate-limit-overview": { "value": { "resources": { @@ -307993,8 +308352,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -311431,7 +311789,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "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-location-list": { @@ -319149,6 +319527,29 @@ "type": "string" } }, + "secret-scanning-alert-assignee": { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, "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.", @@ -319265,15 +319666,6 @@ "type": "integer" } }, - "project-id": { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "security-product": { "name": "security_product", "in": "path", @@ -319305,15 +319697,6 @@ ] } }, - "column-id": { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, "artifact-name": { "name": "name", "description": "The name field of an artifact. When specified, only artifacts with this name will be returned.", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 82cbd6278..c32493b7b 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -1503,6 +1501,152 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise @@ -5129,6 +5273,152 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -5418,6 +5708,24 @@ paths: url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - name: page_size + description: The number of results per page (max 10). + in: query + schema: + type: integer + default: 10 + - name: scope + description: Filter budgets by scope type. + in: query + schema: + type: string + enum: + - enterprise + - organization + - repository + - cost-center responses: '200': "$ref": "#/components/responses/get_all_budgets" @@ -5605,9 +5913,7 @@ paths: in the budget examples: update-budget: - value: - message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + "$ref": "#/components/examples/update-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -17780,6 +18086,138 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + required: + - issue_field_id + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for organization @@ -19347,6 +19785,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -21520,180 +21959,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -21948,406 +22213,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - type: string - pattern: "^(?:first|last|after:\\d+)$" - examples: - - last - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - "$ref": "#/components/parameters/project-id" - - 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 - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/simple-user" - examples: - default: - "$ref": "#/components/examples/simple-user-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - type: string - examples: - - write - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-collaborator-permission" - examples: - default: - "$ref": "#/components/examples/project-collaborator-permission" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -22912,6 +22777,156 @@ paths: enabledForGitHubApps: true category: actions subcategory: artifacts + "/repos/{owner}/{repo}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/repos/{owner}/{repo}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository @@ -45006,6 +45021,7 @@ paths: - "$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-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -45085,6 +45101,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -45111,14 +45129,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -45136,7 +45166,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -48781,184 +48812,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -54965,6 +54818,130 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -70451,6 +70428,72 @@ webhooks: supported-webhook-types: - repository - organization + secret-scanning-alert-assigned: + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 assigned. + operationId: secret-scanning-alert/assigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-created: post: summary: |- @@ -70794,6 +70837,72 @@ webhooks: - repository - organization - app + secret-scanning-alert-unassigned: + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app secret-scanning-alert-validated: post: summary: |- @@ -74207,6 +74316,13 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve the access token @@ -76053,6 +76169,28 @@ components: - html_url - key - name + actions-cache-retention-limit-for-enterprise: + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-enterprise: + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, the maximum + size limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 code-security-configuration: type: object description: A code security configuration @@ -79562,6 +79700,28 @@ components: - reason - url - subscribed + actions-cache-retention-limit-for-organization: + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: For repositories in this organization, the maximum duration, + in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-organization: + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum size limit + for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 dependabot-repository-access-details: title: Dependabot Repository Access Details description: Information about repositories that Dependabot is able to access @@ -79683,6 +79843,10 @@ components: items: "$ref": "#/components/schemas/budget" description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available (maps + to hasNextPage from billing platform) required: - budgets get-budget: @@ -84759,6 +84923,55 @@ components: - created_at - updated_at - project_url + projects-v2-field-single-select-option: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + projects-v2-field-iteration-configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. Individual iterations + can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. projects-v2-item-with-content: title: Projects v2 Item description: An item belonging to a project @@ -85973,7 +86186,8 @@ components: automatic_copilot_code_review_enabled: type: boolean description: Request Copilot code review for new pull requests automatically - if the author has access to Copilot code review. + if the author has access to Copilot code review and their premium + requests quota has not reached the limit. dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -86451,7 +86665,8 @@ components: repository-rule-copilot-code-review: title: copilot_code_review description: Request Copilot code review for new pull requests automatically - if the author has access to Copilot code review. + if the author has access to Copilot code review and their premium requests + quota has not reached the limit. type: object required: - type @@ -86624,6 +86839,7 @@ components: - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" rule-suites: title: Rule Suites description: Response @@ -88403,75 +88619,6 @@ components: - role - state - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: - - string - - 'null' - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions team-repository: title: Team Repository description: A team's access to a repository. @@ -88962,73 +89109,6 @@ components: - watchers_count - created_at - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - examples: - - https://api.github.com/projects/120 - cards_url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - type: integer - examples: - - 42 - node_id: - type: string - examples: - - MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - created_at: - type: string - format: date-time - examples: - - '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - examples: - - '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -89180,6 +89260,26 @@ components: - created_at - expires_at - updated_at + actions-cache-retention-limit-for-repository: + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this repository. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-repository: + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, in gigabytes. + type: integer + examples: + - 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -90943,6 +91043,7 @@ components: - '"chris@ozmm.org"' date: type: string + format: date-time examples: - '"2007-10-29T02:42:39.000-07:00"' verification: @@ -99037,6 +99138,12 @@ components: type: - string - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. + type: + - string + - 'null' secret-scanning-location: type: object properties: @@ -113207,6 +113314,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113835,6 +113947,11 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -201843,6 +201960,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object @@ -201974,6 +202117,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository webhook-secret-scanning-alert-validated: title: secret_scanning_alert validated event type: object @@ -212219,6 +212388,12 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 enterprise-code-security-configuration-list: value: - id: 17 @@ -214376,6 +214551,22 @@ components: alert_recipients: - mona - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa delete-budget: value: message: Budget successfully deleted. @@ -218313,6 +218504,138 @@ components: duration: 14 created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' projects-v2-field: value: id: 12345 @@ -218322,17 +218645,29 @@ components: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' projects-v2-item-with-content: @@ -220714,84 +221049,6 @@ components: url: https://api.github.com/teams/1/memberships/octocat role: member state: pending - team-project-items: - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - team-project: - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false team-repository-alternative-response-with-repository-permissions: value: id: 1296269 @@ -220940,38 +221197,6 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core - project-column: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - project-collaborator-permission: - value: - permission: admin - user: - 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 rate-limit-overview: value: resources: @@ -229043,7 +229268,6 @@ components: metadata: read contents: read issues: write - single_file: write events: - push - pull_request @@ -232098,6 +232322,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + 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-location-list: value: - type: commit @@ -238814,6 +239057,25 @@ components: required: false schema: type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts secret-scanning-alert-sort: name: sort description: The property to sort the results by. `created` means when the alert @@ -238915,13 +239177,6 @@ components: required: true schema: type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -238951,13 +239206,6 @@ components: enum: - enable_all - disable_all - column-id: - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with 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 b8794fd6f..e20e7b232 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 @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -5443,6 +5439,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6575,6 +6579,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7480,6 +7492,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7950,6 +7970,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10278,6 +10306,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11442,6 +11478,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12470,6 +12514,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13201,6 +13253,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -18515,17 +18575,17 @@ } } }, - "/enterprises/{enterprise}/code-security/configurations": { + "/enterprises/{enterprise}/actions/cache/retention-limit": { "get": { - "summary": "Get code security configurations for an enterprise", - "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "summary": "Get GitHub Actions cache retention limit for an enterprise", + "description": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ - "code-security" + "actions" ], - "operationId": "code-security/get-configurations-for-enterprise", + "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { @@ -18536,34 +18596,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "in": "query", - "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).\"", - "required": false, - "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" - } } ], "responses": { @@ -18572,345 +18604,963 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": [ - "object", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": [ - "object", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] } } }, "examples": { "default": { - "value": [ - { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "enterprise", - "name": "High risk settings", - "description": "This is a code security configuration for octo-enterprise high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", - "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" - } - ] + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an enterprise", + "description": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-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": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an enterprise", + "description": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an enterprise", + "description": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an enterprise", + "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "in": "query", + "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).\"", + "required": false, + "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" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] } } } @@ -60378,6 +61028,596 @@ } } }, + "/organizations/{org}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an organization", + "description": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-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": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an organization", + "description": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-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": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/organizations/{org}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an organization", + "description": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an organization", + "description": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -61824,6 +63064,47 @@ "schema": { "type": "string" } + }, + { + "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 + } + }, + { + "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_size", + "description": "The number of results per page (max 10).", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost-center" + ] + } } ], "responses": { @@ -61925,6 +63206,10 @@ ] }, "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ @@ -62593,7 +63878,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } } } @@ -117213,6 +118513,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -118360,6 +119668,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -160065,19 +161381,17 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for organization", - "description": "Get a specific field for an organization-owned project.", + }, + "post": { + "summary": "Add a field to an organization-owned project.", + "description": "Add a field to an organization-owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-org", + "operationId": "projects/add-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { @@ -160089,15 +161403,6 @@ "type": "integer" } }, - { - "name": "field_id", - "description": "The unique identifier of the field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -160108,9 +161413,761 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "issue_field_id": { + "type": "integer", + "description": "The ID of the IssueField to create the field for." + } + }, + "required": [ + "issue_field_id" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Response for adding a field to an organization-owned project.", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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": "projects", + "subcategory": "fields" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for organization", + "description": "Get a specific field for an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "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": { @@ -160316,21 +162373,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -183868,7 +185943,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -184506,7 +186581,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -185154,7 +187229,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -185789,6 +187864,35 @@ ] } } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } } ] } @@ -186501,7 +188605,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -187139,7 +189243,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -188535,7 +190639,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -189173,7 +191277,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -189846,7 +191950,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -190481,6 +192585,35 @@ ] } } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } } ] } @@ -191189,7 +193322,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -191827,7 +193960,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -192534,6 +194667,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -211879,17 +214035,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -211937,44 +214093,36 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -212142,55 +214290,660 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "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", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -212198,17 +214951,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -212228,1607 +214975,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "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}", + "git_url": "git:github.com/octocat/Hello-World.git", + "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}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "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}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team 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/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": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "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}", - "git_url": "git:github.com/octocat/Hello-World.git", - "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}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "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}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -215562,152 +216799,463 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { + "/rate_limit": { "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "projects-classic" + "rate-limit" ], - "operationId": "projects-classic/get-column", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" ] } }, "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" + } + }, + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -215733,3136 +217281,839 @@ } } } - }, - "401": { - "description": "Requires authentication", - "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": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/update-column", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "Hello-World" ] }, - "project_url": { + "full_name": { + "type": "string", + "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" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" ] }, - "cards_url": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 42 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "name": { - "description": "Name of the project column", + "blobs_url": { "type": "string", "examples": [ - "Remaining tasks" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "created_at": { + "branches_url": { "type": "string", - "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "updated_at": { + "collaborators_url": { "type": "string", - "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] }, - "url": { - "type": "string" + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] }, - "documentation_url": { - "type": "string" + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] }, - "url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "documentation_url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] }, - "documentation_url": { - "type": "string" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] }, - "url": { - "type": "string" + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] }, - "documentation_url": { - "type": "string" + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, - "url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] }, - "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" + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] }, - "documentation_url": { - "type": "string" + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] }, - "url": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "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" - ] - } + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] }, - "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": [ - { - "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" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "url": { - "type": "string" + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, - "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" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] }, - "documentation_url": { - "type": "string" + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] }, - "documentation_url": { - "type": "string" + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, - "url": { - "type": "string" + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] }, - "documentation_url": { - "type": "string" + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "url": { - "type": "string" + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "type": "string", - "examples": [ - "write" - ] - } - } - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] }, - "documentation_url": { - "type": "string" + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, - "url": { - "type": "string" + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] }, - "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" + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "documentation_url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] }, - "documentation_url": { - "type": "string" + "language": { + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] }, - "documentation_url": { - "type": "string" + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] }, - "url": { - "type": "string" + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "type": "string", + "examples": [ + "master" + ] }, - "documentation_url": { - "type": "string" + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] }, - "url": { - "type": "string" + "is_template": { + "type": "boolean", + "examples": [ + true + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "documentation_url": { - "type": "string" + "has_issues": { + "type": "boolean", + "examples": [ + true + ] }, - "url": { - "type": "string" + "has_projects": { + "type": "boolean", + "examples": [ + true + ] }, - "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" + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] }, - "documentation_url": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] }, - "documentation_url": { - "type": "string" + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] }, - "url": { - "type": "string" + "archived": { + "type": "boolean" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "user": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" + ] + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1 + 42 ] }, "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" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "events_url": { + "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "Team Environment" ] }, - "received_events_url": { + "full_name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "octocat/Hello-World" ] }, - "type": { - "type": "string", - "examples": [ - "User" + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } ] }, - "site_admin": { - "type": "boolean" + "forks": { + "type": "integer" }, - "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": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "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 - } - } - } - } - } - } - }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" ] }, "owner": { @@ -228624,6 +227875,632 @@ } } }, + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for a repository", + "description": "Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for a repository", + "description": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for a repository", + "description": "Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for a repository", + "description": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/repos/{owner}/{repo}/actions/cache/usage": { "get": { "summary": "Get GitHub Actions cache usage for a repository", @@ -258476,6 +258353,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -258508,6 +258386,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -279936,6 +279815,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -279968,6 +279848,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -321788,6 +321669,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -321820,6 +321702,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -328830,6 +328713,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -328862,6 +328746,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -335268,6 +335153,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -335300,6 +335186,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -335988,6 +335875,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -336020,6 +335908,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -336740,6 +336629,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -336772,6 +336662,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -375505,6 +375396,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -400314,8 +400213,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -478811,6 +478709,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -478843,6 +478742,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -516344,6 +516244,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -516376,6 +516277,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -541209,7 +541111,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -542211,7 +542113,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -543036,7 +542938,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -543674,7 +543576,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -544189,7 +544091,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -544827,7 +544729,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -545555,7 +545457,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -546193,7 +546095,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -547608,7 +547510,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -548246,7 +548148,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -548776,7 +548678,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -549414,7 +549316,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -550138,7 +550040,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -550776,7 +550678,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -551499,6 +551401,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -554285,7 +554210,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -554360,6 +554285,13 @@ "string", "null" ] + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] } }, "anyOf": [ @@ -554367,6 +554299,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -554376,6 +554313,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -555625,7 +555574,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "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 + } } } } @@ -555639,7 +555608,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -587991,6 +587960,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -588271,6 +588241,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -603707,17 +603678,17 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { + "/teams/{team_id}/repos": { "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-projects-legacy", + "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -603756,44 +603727,36 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -603961,55 +603924,660 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "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", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -604017,17 +604585,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -604047,1796 +604609,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "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}", + "git_url": "git:github.com/octocat/Hello-World.git", + "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}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "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}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "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, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "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, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/repos": { - "get": { - "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "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}", - "git_url": "git:github.com/octocat/Hello-World.git", - "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}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "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}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -637273,6 +636136,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -696490,6 +695361,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -703951,51 +702830,280 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for user", - "description": "Get a specific field for a user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "name": "project_number", - "description": "The project's number.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.", + "name": "project_number", + "description": "The project's number.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { @@ -704192,7 +703300,40 @@ ] }, "examples": { - "default": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { "value": { "id": 12345, "node_id": "PVTF_lADOABCD1234567890", @@ -704202,37 +703343,521 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "304": { @@ -765962,6 +765587,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -768741,6 +768373,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -897391,6 +897030,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -900498,6 +900145,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -903510,6 +903165,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -906522,6 +906185,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -909668,6 +909339,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -912821,6 +912500,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -917969,6 +917656,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1372370,7 +1372065,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1373008,7 +1372703,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1375674,7 +1375369,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1376312,7 +1376007,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1378978,7 +1378673,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1379616,7 +1379311,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1380056,7 +1379751,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1380694,7 +1380389,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1380962,7 +1380657,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1381600,7 +1381295,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1381630,949 +1381325,5099 @@ ] } }, - "updated": { + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "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", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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/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/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" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "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" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "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", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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/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/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" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "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" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "type": "object", - "properties": { - "rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1382745,7 +1386590,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1382760,8 +1386605,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1382769,13 +1386615,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1382840,206 +1386686,186 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1384915,7 +1388741,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1384931,23 +1388757,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1385012,15 +1388836,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1386895,6 +1390903,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1386910,21 +1390919,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "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", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1386991,13 +1390998,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1389070,11 +1393077,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "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", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1389141,13 +1393148,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1389158,9 +1393165,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1389180,12 +1393184,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1389285,9 +1393283,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1389329,7 +1393324,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1391204,285 +1395200,1126 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "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", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": [ - "object", - "null" - ], - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "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." + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + 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" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "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).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "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." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "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" + ] + } + ] + } + } + }, + "assignee": { + "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" + ] }, "enterprise": { "title": "Enterprise", @@ -1393359,8 +1398196,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1393374,21 +1398210,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "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", + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1393453,184 +1398290,856 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "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 + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "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." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "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" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] - }, - "url": { - "type": "string", - "format": "uri" } - } - }, - "external_identifier": { - "type": "string" + ] }, - "external_reference": { + "resolution_comment": { "type": [ "string", "null" ], - "format": "uri" + "description": "An optional comment to resolve an alert." }, - "fix_reason": { - "type": "string" + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." }, - "fixed_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time" + "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).\"" }, - "fixed_in": { - "type": "string" + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "id": { - "type": "integer" + "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" + ] + } + ] }, - "node_id": { - "type": "string" + "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`." }, - "number": { - "type": "integer" + "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" + ] + } + ] }, - "severity": { - "type": "string" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "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." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "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" + ] + } ] } } @@ -1395510,8 +1401019,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1395525,21 +1401033,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1395604,7 +1401113,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1396458,96 +1401967,6 @@ } } }, - "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/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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1396573,6 +1401992,354 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "examples": [ + "commit" + ] + }, + "details": { + "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" + ] + } + ] + } + } + }, "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.", @@ -1398331,10 +1404098,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1398346,8 +1404288,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1398356,13 +1404299,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1398427,13 +1404370,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1399281,378 +1405224,120 @@ } } }, - "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "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/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": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "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" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "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" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1401412,185 +1407097,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1401602,9 +1407112,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1401613,11 +1407122,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1401684,13 +1407193,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1404436,11 +1409945,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1404507,13 +1410016,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1407259,11 +1412768,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1407330,13 +1412839,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1408184,6 +1413693,174 @@ } } }, + "assignee": { + "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" + ] + }, "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/admin/overview/about-enterprise-accounts).\"", 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 0fb62e763..69c335667 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 @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -440,7 +438,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &38 + - &43 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 @@ -449,7 +447,7 @@ paths: required: false schema: type: string - - &39 + - &44 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 @@ -458,7 +456,7 @@ paths: required: false schema: type: string - - &46 + - &50 name: direction description: The direction to sort the results by. in: query @@ -697,7 +695,7 @@ paths: required: - vector_string - score - cvss_severities: &48 + cvss_severities: &52 type: - object - 'null' @@ -744,7 +742,7 @@ paths: required: - vector_string - score - epss: &49 + epss: &53 type: - object - 'null' @@ -907,7 +905,7 @@ paths: - subscriptions_url - type - url - type: &289 + type: &296 type: string description: The type of credit the user is receiving. enum: @@ -1040,7 +1038,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &106 + schema: &112 title: Validation Error Simple description: Validation Error Simple type: object @@ -1073,7 +1071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &613 + - &617 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1658,7 +1656,7 @@ paths: schema: type: integer default: 30 - - &186 + - &192 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 @@ -1674,7 +1672,7 @@ paths: application/json: schema: type: array - items: &187 + items: &193 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1770,7 +1768,7 @@ paths: - installation_id - repository_id examples: - default: &188 + default: &194 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1833,7 +1831,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &105 + schema: &111 title: Validation Error description: Validation Error type: object @@ -1905,7 +1903,7 @@ paths: description: Response content: application/json: - schema: &189 + schema: &195 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2040,7 +2038,7 @@ paths: - request - response examples: - default: &190 + default: &196 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2244,7 +2242,7 @@ paths: parameters: - *17 - *19 - - &68 + - &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) @@ -2343,6 +2341,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -2832,7 +2837,7 @@ paths: suspended_at: suspended_by: headers: - Link: &52 + Link: &56 example: ; rel="next", ; rel="last" schema: @@ -3022,7 +3027,7 @@ paths: - selected repositories: type: array - items: &64 + items: &68 title: Repository description: A repository on GitHub. type: object @@ -3049,7 +3054,7 @@ paths: license: anyOf: - type: 'null' - - &79 + - &83 title: License Simple description: License Simple type: object @@ -5427,7 +5432,7 @@ paths: responses: '202': *37 '422': *7 - '500': &96 + '500': &102 description: Internal Error content: application/json: @@ -7342,6 +7347,166 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - &38 + 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: &39 + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, + the maximum duration, in days, for which caches in a repository + may be retained. + type: integer + examples: + - 14 + examples: + default: &40 + value: + max_cache_retention_days: 80 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - *38 + requestBody: + required: true + content: + application/json: + schema: *39 + examples: + selected_actions: *40 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *38 + responses: + '200': + description: Response + content: + application/json: + schema: &41 + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, + the maximum size limit for the sum of all caches in a repository, + in gigabytes. + type: integer + examples: + - 10 + examples: + default: &42 + value: + max_cache_size_gb: 150 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *38 + requestBody: + required: true + content: + application/json: + schema: *41 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise @@ -7358,13 +7523,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - - &40 - name: enterprise - description: The slug version of the enterprise name. - in: path - required: true - schema: - type: string + - *38 - name: per_page in: query description: The number of results per page (max 100). For more information, @@ -7373,8 +7532,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -7382,7 +7541,7 @@ paths: application/json: schema: type: array - items: &41 + items: &45 type: object description: A code security configuration properties: @@ -7679,7 +7838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - - *40 + - *38 requestBody: required: true content: @@ -7757,7 +7916,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &164 + code_scanning_options: &170 type: - object - 'null' @@ -7776,7 +7935,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &44 + code_scanning_default_setup_options: &48 type: - object - 'null' @@ -7895,9 +8054,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *41 + schema: *45 examples: - default: &42 + default: &46 value: id: 1325 target_type: enterprise @@ -7949,13 +8108,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - - *40 + - *38 responses: '200': description: Response content: application/json: - schema: &166 + schema: &172 type: array description: A list of default code security configurations items: @@ -7969,9 +8128,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *41 + configuration: *45 examples: - default: &167 + default: &173 value: - default_for_new_repos: public configuration: @@ -8059,8 +8218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - - *40 - - &43 + - *38 + - &47 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -8072,9 +8231,9 @@ paths: description: Response content: application/json: - schema: *41 + schema: *45 examples: - default: *42 + default: *46 '304': *35 '403': *27 '404': *6 @@ -8098,8 +8257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - - *40 - - *43 + - *38 + - *47 requestBody: required: true content: @@ -8178,7 +8337,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *44 + code_scanning_default_setup_options: *48 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -8266,13 +8425,13 @@ paths: description: Response content: application/json: - schema: *41 + schema: *45 examples: - default: *42 + default: *46 '304': *35 '403': *27 '404': *6 - '409': &45 + '409': &49 description: Conflict content: application/json: @@ -8299,15 +8458,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - - *40 - - *43 + - *38 + - *47 responses: - '204': &168 + '204': &174 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8331,8 +8490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - - *40 - - *43 + - *38 + - *47 requestBody: required: true content: @@ -8359,7 +8518,7 @@ paths: '202': *37 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -8383,8 +8542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - - *40 - - *43 + - *38 + - *47 requestBody: required: true content: @@ -8424,12 +8583,12 @@ paths: - none - private_and_internal - public - configuration: *41 + configuration: *45 examples: default: value: default_for_new_repos: all - configuration: &165 + configuration: &171 value: id: 1325 target_type: organization @@ -8485,8 +8644,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - - *40 - - *43 + - *38 + - *47 - 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)." @@ -8495,8 +8654,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -8514,7 +8673,7 @@ paths: application/json: schema: type: array - items: &169 + items: &175 type: object description: Repositories associated with a code security configuration and attachment status @@ -8532,7 +8691,7 @@ paths: - failed - updating - removed_by_enterprise - repository: &51 + repository: &55 title: Simple Repository description: A GitHub repository. type: object @@ -8859,7 +9018,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &170 + repository: &176 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8952,8 +9111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *40 - - &173 + - *38 + - &179 name: state in: query description: |- @@ -8962,7 +9121,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &174 + - &180 name: severity in: query description: |- @@ -8971,7 +9130,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &175 + - &181 name: ecosystem in: query description: |- @@ -8980,14 +9139,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &176 + - &182 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &177 + - &183 name: epss_percentage in: query description: |- @@ -8999,7 +9158,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 - - &454 + - &458 name: has in: query description: |- @@ -9013,7 +9172,7 @@ paths: type: string enum: - patch - - &178 + - &184 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9023,7 +9182,7 @@ paths: enum: - development - runtime - - &179 + - &185 name: sort in: query description: |- @@ -9038,9 +9197,9 @@ paths: - updated - epss_percentage default: created - - *46 - - *38 - - *39 + - *50 + - *43 + - *44 - *17 responses: '200': @@ -9049,11 +9208,11 @@ paths: application/json: schema: type: array - items: &180 + items: &186 type: object description: A Dependabot alert. properties: - number: &154 + number: &160 type: integer description: The security alert number. readOnly: true @@ -9071,7 +9230,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &47 + package: &51 type: object description: Details for the vulnerable package. readOnly: true @@ -9119,7 +9278,7 @@ paths: - direct - transitive - - security_advisory: &455 + security_advisory: &459 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9150,13 +9309,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &50 + items: &54 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *47 + package: *51 severity: type: string description: The severity of the vulnerability. @@ -9224,8 +9383,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *48 - epss: *49 + cvss_severities: *52 + epss: *53 cwes: type: array description: Details for the advisory pertaining to Common @@ -9325,30 +9484,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *50 - url: &157 + security_vulnerability: *54 + url: &163 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &158 + html_url: &164 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &155 + created_at: &161 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: &156 + updated_at: &162 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: &160 + dismissed_at: &166 type: - string - 'null' @@ -9379,7 +9538,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &159 + fixed_at: &165 type: - string - 'null' @@ -9387,7 +9546,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &456 + auto_dismissed_at: &460 type: - string - 'null' @@ -9395,7 +9554,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - repository: *51 + repository: *55 required: - number - state @@ -9414,7 +9573,7 @@ paths: - repository additionalProperties: false examples: - default: &181 + default: &187 value: - number: 2 state: dismissed @@ -9753,7 +9912,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - - *40 + - *38 - *17 - *19 responses: @@ -9763,7 +9922,7 @@ paths: application/json: schema: type: array - items: &53 + items: &57 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -9828,7 +9987,7 @@ paths: - updated_at - group_id examples: - default: &54 + default: &58 value: - id: 1 name: Justice League @@ -9841,7 +10000,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -9859,7 +10018,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - - *40 + - *38 requestBody: required: true content: @@ -9916,9 +10075,9 @@ paths: description: Response content: application/json: - schema: *53 + schema: *57 examples: - default: *54 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9935,8 +10094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - - *40 - - &55 + - *38 + - &59 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -9955,7 +10114,7 @@ paths: type: array items: *4 examples: - default: &56 + default: &60 value: - login: octocat id: 1 @@ -9976,7 +10135,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9993,8 +10152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10025,7 +10184,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10042,8 +10201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10074,7 +10233,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10091,9 +10250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - - *40 - - *55 - - &57 + - *38 + - *59 + - &61 name: username description: The handle for the GitHub user account. in: path @@ -10107,7 +10266,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &58 + exampleKey1: &62 value: login: octocat id: 1 @@ -10142,9 +10301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - - *40 - - *55 - - *57 + - *38 + - *59 + - *61 responses: '201': description: Successfully added team member @@ -10152,7 +10311,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *58 + exampleKey1: *62 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10169,9 +10328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - - *40 - - *55 - - *57 + - *38 + - *59 + - *61 responses: '204': description: Response @@ -10192,8 +10351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - - *40 - - *55 + - *38 + - *59 - *17 - *19 responses: @@ -10203,7 +10362,7 @@ paths: application/json: schema: type: array - items: &59 + items: &63 title: Organization Simple description: A GitHub organization. type: object @@ -10275,7 +10434,7 @@ paths: - avatar_url - description examples: - default: &60 + default: &64 value: login: github id: 1 @@ -10305,8 +10464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10334,9 +10493,9 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: &94 + default: &98 value: - login: github id: 1 @@ -10366,8 +10525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10407,9 +10566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - - *40 - - *55 - - &61 + - *38 + - *59 + - &65 name: org description: The organization name. The name is not case sensitive. in: path @@ -10421,9 +10580,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *59 + schema: *63 examples: - default: *60 + default: *64 '404': description: The team is not assigned to the organization x-github: @@ -10441,17 +10600,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - - *40 - - *55 - - *61 + - *38 + - *59 + - *65 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *59 + schema: *63 examples: - default: *60 + default: *64 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10467,9 +10626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - - *40 - - *55 - - *61 + - *38 + - *59 + - *65 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -10492,8 +10651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - - *40 - - &62 + - *38 + - &66 name: team_slug description: The slug of the team name. in: path @@ -10505,11 +10664,11 @@ paths: description: Response content: application/json: - schema: *53 + schema: *57 examples: - default: *54 + default: *58 headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -10526,8 +10685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - - *40 - - *62 + - *38 + - *66 requestBody: required: true content: @@ -10585,11 +10744,11 @@ paths: description: Response content: application/json: - schema: *53 + schema: *57 examples: - default: *54 + default: *58 headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -10609,8 +10768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - - *40 - - *62 + - *38 + - *66 responses: '204': description: Response @@ -10648,7 +10807,7 @@ paths: application/json: schema: type: array - items: &89 + items: &93 title: Event description: Event type: object @@ -10659,7 +10818,7 @@ paths: type: - string - 'null' - actor: &63 + actor: &67 title: Actor description: Actor type: object @@ -10700,13 +10859,13 @@ paths: - id - name - url - org: *63 + org: *67 payload: type: object properties: action: type: string - issue: &78 + issue: &82 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -10827,7 +10986,7 @@ paths: milestone: anyOf: - type: 'null' - - &244 + - &250 title: Milestone description: A collection of related issues and pull requests. @@ -10999,7 +11158,7 @@ paths: timeline_url: type: string format: uri - type: &208 + type: &214 title: Issue Type description: The type of issue. type: @@ -11052,12 +11211,12 @@ paths: - node_id - name - description - repository: *64 + repository: *68 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &65 + author_association: &69 title: author_association type: string description: How the author is associated with the repository. @@ -11072,7 +11231,7 @@ paths: - OWNER examples: - OWNER - reactions: &66 + reactions: &70 title: Reaction Rollup type: object properties: @@ -11108,7 +11267,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &625 + sub_issues_summary: &629 title: Sub-issues Summary type: object properties: @@ -11129,7 +11288,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &626 + issue_dependencies_summary: &630 title: Issue Dependencies Summary type: object properties: @@ -11148,7 +11307,7 @@ paths: - total_blocking issue_field_values: type: array - items: &627 + items: &631 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11243,7 +11402,7 @@ paths: - user - created_at - updated_at - comment: &503 + comment: &507 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11293,12 +11452,12 @@ paths: issue_url: type: string format: uri - author_association: *65 + author_association: *69 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *66 + reactions: *70 required: - id - node_id @@ -11386,7 +11545,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': &97 + '503': &103 description: Service unavailable content: application/json: @@ -11488,7 +11647,7 @@ paths: _links: type: object properties: - timeline: &67 + timeline: &71 title: Link With Type description: Hypermedia Link with Type type: object @@ -11500,17 +11659,17 @@ paths: required: - href - type - user: *67 - security_advisories: *67 - current_user: *67 - current_user_public: *67 - current_user_actor: *67 - current_user_organization: *67 + 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: *67 - repository_discussions: *67 - repository_discussions_category: *67 + items: *71 + repository_discussions: *71 + repository_discussions_category: *71 required: - timeline - user @@ -11572,7 +11731,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *68 + - *72 - *17 - *19 responses: @@ -11582,7 +11741,7 @@ paths: application/json: schema: type: array - items: &69 + items: &73 title: Base Gist description: Base Gist type: object @@ -11679,7 +11838,7 @@ paths: - created_at - updated_at examples: - default: &70 + default: &74 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -11724,7 +11883,7 @@ paths: site_admin: false truncated: false headers: - Link: *52 + Link: *56 '304': *35 '403': *27 x-github: @@ -11803,7 +11962,7 @@ paths: description: Response content: application/json: - schema: &71 + schema: &75 title: Gist Simple description: Gist Simple type: object @@ -11821,7 +11980,7 @@ paths: url: type: string format: uri - user: &639 + user: &641 title: Public User description: Public User type: object @@ -12195,7 +12354,7 @@ paths: truncated: type: boolean examples: - default: &72 + default: &76 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -12299,7 +12458,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *68 + - *72 - *17 - *19 responses: @@ -12309,11 +12468,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *70 + default: *74 headers: - Link: *52 + Link: *56 '422': *15 '304': *35 '403': *27 @@ -12333,7 +12492,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *68 + - *72 - *17 - *19 responses: @@ -12343,11 +12502,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *70 + default: *74 headers: - Link: *52 + Link: *56 '401': *23 '304': *35 '403': *27 @@ -12373,7 +12532,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &73 + - &77 name: gist_id description: The unique identifier of the gist. in: path @@ -12385,10 +12544,10 @@ paths: description: Response content: application/json: - schema: *71 + schema: *75 examples: - default: *72 - '403': &76 + default: *76 + '403': &80 description: Forbidden Gist content: application/json: @@ -12437,7 +12596,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *73 + - *77 requestBody: required: true content: @@ -12501,9 +12660,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *75 examples: - updateGist: *72 + updateGist: *76 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -12661,7 +12820,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *73 + - *77 responses: '204': description: Response @@ -12690,7 +12849,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *73 + - *77 - *17 - *19 responses: @@ -12700,7 +12859,7 @@ paths: application/json: schema: type: array - items: &74 + items: &78 title: Gist Comment description: A comment made to a gist. type: object @@ -12738,7 +12897,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *65 + author_association: *69 required: - url - id @@ -12778,7 +12937,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -12803,7 +12962,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *73 + - *77 requestBody: required: true content: @@ -12829,9 +12988,9 @@ paths: description: Response content: application/json: - schema: *74 + schema: *78 examples: - default: &75 + default: &79 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -12889,8 +13048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *73 - - &77 + - *77 + - &81 name: comment_id description: The unique identifier of the comment. in: path @@ -12903,12 +13062,12 @@ paths: description: Response content: application/json: - schema: *74 + schema: *78 examples: - default: *75 + default: *79 '304': *35 '404': *6 - '403': *76 + '403': *80 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12930,8 +13089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *73 - *77 + - *81 requestBody: required: true content: @@ -12957,9 +13116,9 @@ paths: description: Response content: application/json: - schema: *74 + schema: *78 examples: - default: *75 + default: *79 '404': *6 x-github: githubCloudOnly: false @@ -12976,8 +13135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *73 - *77 + - *81 responses: '204': description: Response @@ -13000,7 +13159,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *73 + - *77 - *17 - *19 responses: @@ -13101,7 +13260,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *73 + - *77 - *17 - *19 responses: @@ -13111,7 +13270,7 @@ paths: application/json: schema: type: array - items: *71 + items: *75 examples: default: value: @@ -13157,7 +13316,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '404': *6 '304': *35 '403': *27 @@ -13176,13 +13335,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *73 + - *77 responses: '201': description: Response content: application/json: - schema: *69 + schema: *73 examples: default: value: @@ -13253,7 +13412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *73 + - *77 responses: '204': description: Response if gist is starred @@ -13283,7 +13442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *73 + - *77 responses: '204': description: Response @@ -13305,7 +13464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *73 + - *77 responses: '204': description: Response @@ -13334,7 +13493,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *73 + - *77 - name: sha in: path required: true @@ -13345,9 +13504,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *75 examples: - default: *72 + default: *76 '422': *15 '404': *6 '403': *27 @@ -13508,7 +13667,7 @@ paths: type: integer repositories: type: array - items: *64 + items: *68 repository_selection: type: string examples: @@ -13632,7 +13791,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *52 + Link: *56 '403': *27 '304': *35 '401': *23 @@ -13716,7 +13875,7 @@ paths: - closed - all default: open - - &211 + - &217 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13734,8 +13893,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - name: collab in: query required: false @@ -13765,9 +13924,9 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: &212 + default: &218 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14011,7 +14170,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *52 + Link: *56 '422': *15 '304': *35 '404': *6 @@ -14046,7 +14205,7 @@ paths: application/json: schema: type: array - items: *79 + items: *83 examples: default: value: @@ -14344,7 +14503,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &80 + X-CommonMarker-Version: &84 example: 0.17.4 schema: type: string @@ -14399,7 +14558,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *80 + X-CommonMarker-Version: *84 content: text/html: schema: @@ -14428,7 +14587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &83 + - &87 name: account_id description: account_id parameter in: path @@ -14440,7 +14599,7 @@ paths: description: Response content: application/json: - schema: &82 + schema: &86 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -14474,7 +14633,7 @@ paths: - 'null' id: type: integer - plan: &81 + plan: &85 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -14577,7 +14736,7 @@ paths: - 'null' updated_at: type: string - plan: *81 + plan: *85 required: - url - id @@ -14585,7 +14744,7 @@ paths: - login - marketplace_purchase examples: - default: &84 + default: &88 value: url: https://api.github.com/orgs/github type: Organization @@ -14670,9 +14829,9 @@ paths: application/json: schema: type: array - items: *81 + items: *85 examples: - default: &85 + default: &89 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -14690,7 +14849,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *52 + Link: *56 '404': *6 '401': *23 x-github: @@ -14712,14 +14871,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &86 + - &90 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &87 + - &91 name: sort description: The property to sort the results by. in: query @@ -14749,9 +14908,9 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: &88 + default: &92 value: - url: https://api.github.com/orgs/github type: Organization @@ -14802,7 +14961,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *52 + Link: *56 '404': *6 '422': *15 '401': *23 @@ -14825,15 +14984,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *84 + default: *88 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -14865,11 +15024,11 @@ paths: application/json: schema: type: array - items: *81 + items: *85 examples: - default: *85 + default: *89 headers: - Link: *52 + Link: *56 '401': *23 x-github: githubCloudOnly: false @@ -14890,8 +15049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *86 - - *87 + - *90 + - *91 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -14911,11 +15070,11 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *88 + default: *92 headers: - Link: *52 + Link: *56 '401': *23 x-github: githubCloudOnly: false @@ -15178,14 +15337,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &311 + - &316 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &312 + - &317 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -15202,7 +15361,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -15247,7 +15406,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &318 + '301': &320 description: Moved permanently content: application/json: @@ -15269,7 +15428,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &532 + - &536 name: all description: If `true`, show notifications marked as read. in: query @@ -15277,7 +15436,7 @@ paths: schema: type: boolean default: false - - &533 + - &537 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -15286,8 +15445,8 @@ paths: schema: type: boolean default: false - - *68 - - &534 + - *72 + - &538 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: @@ -15312,14 +15471,14 @@ paths: application/json: schema: type: array - items: &90 + items: &94 title: Thread description: Thread type: object properties: id: type: string - repository: &136 + repository: &142 title: Minimal Repository description: Minimal Repository type: object @@ -15658,7 +15817,7 @@ paths: type: boolean examples: - false - security_and_analysis: &257 + security_and_analysis: &263 type: - object - 'null' @@ -15823,7 +15982,7 @@ paths: - url - subscription_url examples: - default: &535 + default: &539 value: - id: '1' repository: @@ -15905,7 +16064,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -15989,7 +16148,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &91 + - &95 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 @@ -16003,7 +16162,7 @@ paths: description: Response content: application/json: - schema: *90 + schema: *94 examples: default: value: @@ -16105,7 +16264,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *91 + - *95 responses: '205': description: Reset Content @@ -16127,7 +16286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *91 + - *95 responses: '204': description: No content @@ -16150,13 +16309,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *91 + - *95 responses: '200': description: Response content: application/json: - schema: &92 + schema: &96 title: Thread Subscription description: Thread Subscription type: object @@ -16200,7 +16359,7 @@ paths: - url - subscribed examples: - default: &93 + default: &97 value: subscribed: true ignored: false @@ -16231,7 +16390,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *91 + - *95 requestBody: required: false content: @@ -16252,9 +16411,9 @@ paths: description: Response content: application/json: - schema: *92 + schema: *96 examples: - default: *93 + default: *97 '304': *35 '403': *27 '401': *23 @@ -16277,7 +16436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *91 + - *95 responses: '204': description: Response @@ -16372,9 +16531,9 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: *94 + default: *98 headers: Link: example: ; rel="next" @@ -16386,6 +16545,154 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - *65 + responses: + '200': + description: Response + content: + application/json: + schema: &99 + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: For repositories in this organization, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + examples: + default: *40 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - *65 + requestBody: + required: true + content: + application/json: + schema: *99 + examples: + selected_actions: *40 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - *65 + responses: + '200': + description: Response + content: + application/json: + schema: &100 + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum + size limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 + examples: + default: *42 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - *65 + requestBody: + required: true + content: + application/json: + schema: *100 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -16401,7 +16708,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: - - *61 + - *65 - name: page in: query description: The page number of results to fetch. @@ -16447,7 +16754,7 @@ paths: items: anyOf: - type: 'null' - - *51 + - *55 additionalProperties: false examples: default: @@ -16552,7 +16859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -16618,7 +16925,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *61 + - *65 requestBody: required: true content: @@ -16671,7 +16978,7 @@ paths: 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 + - *65 responses: '200': description: Response @@ -16679,7 +16986,7 @@ paths: application/json: schema: type: array - items: &95 + items: &101 title: Custom Property Value description: Custom property name and associated value type: object @@ -16702,7 +17009,7 @@ paths: - property_name - value examples: - default: &541 + default: &545 value: - property_name: environment value: production @@ -16736,7 +17043,7 @@ paths: 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 + - *65 requestBody: required: true content: @@ -16748,11 +17055,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *95 + items: *101 required: - properties examples: - default: &542 + default: &546 value: properties: - property_name: environment @@ -16788,7 +17095,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *61 + - *65 + - *19 + - *17 + - name: page_size + description: The number of results per page (max 10). + in: query + schema: + type: integer + default: 10 + - name: scope + description: Filter budgets by scope type. + in: query + schema: + type: string + enum: + - enterprise + - organization + - repository + - cost-center responses: '200': description: Response when getting all budgets @@ -16870,6 +17195,10 @@ paths: - prevent_further_usage - budget_alerting description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available + (maps to hasNextPage from billing platform) required: - budgets examples: @@ -16911,7 +17240,7 @@ paths: alert_recipients: [] '404': *6 '403': *27 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16932,8 +17261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *61 - - &98 + - *65 + - &104 name: budget_id description: The ID corresponding to the budget. in: path @@ -17032,8 +17361,8 @@ paths: '400': *14 '404': *6 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17053,8 +17382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *61 - - *98 + - *65 + - *104 requestBody: required: true content: @@ -17179,7 +17508,19 @@ paths: update-budget: value: message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *23 '403': *27 @@ -17228,8 +17569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *61 - - *98 + - *65 + - *104 responses: '200': description: Response when deleting a budget @@ -17255,8 +17596,8 @@ paths: '400': *14 '404': *6 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17276,8 +17617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *61 - - &99 + - *65 + - &105 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, @@ -17286,7 +17627,7 @@ paths: required: false schema: type: integer - - &101 + - &107 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 @@ -17295,7 +17636,7 @@ paths: required: false schema: type: integer - - &100 + - &106 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 @@ -17310,14 +17651,14 @@ paths: required: false schema: type: string - - &677 + - &688 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &102 + - &108 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -17433,8 +17774,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17454,9 +17795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *61 - - *99 - - &678 + - *65 + - *105 + - &689 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 @@ -17465,7 +17806,7 @@ paths: required: false schema: type: integer - - *100 + - *106 responses: '200': description: Billing usage report response for an organization @@ -17540,8 +17881,8 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17564,19 +17905,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *61 - - *99 - - *101 - - *100 - - &679 + - *65 + - *105 + - *107 + - *106 + - &690 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *102 - - &680 + - *108 + - &691 name: sku description: The SKU to query for usage. in: query @@ -17686,8 +18027,8 @@ paths: netAmount: 8.0 '400': *14 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17713,13 +18054,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &103 + schema: &109 title: Organization Full description: Organization Full type: object @@ -18114,7 +18455,7 @@ paths: - updated_at - archived_at examples: - default-response: &104 + default-response: &110 value: login: github id: 1 @@ -18214,7 +18555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *61 + - *65 requestBody: required: false content: @@ -18431,18 +18772,18 @@ paths: description: Response content: application/json: - schema: *103 + schema: *109 examples: - default: *104 + default: *110 '422': description: Validation failed content: application/json: schema: oneOf: - - *105 - - *106 - '409': *45 + - *111 + - *112 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18465,7 +18806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *61 + - *65 responses: '202': *37 '404': *6 @@ -18490,7 +18831,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -18516,7 +18857,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18537,7 +18878,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: - - *61 + - *65 - *17 - *19 responses: @@ -18555,7 +18896,7 @@ paths: type: integer repository_cache_usages: type: array - items: &323 + items: &327 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -18593,7 +18934,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18613,7 +18954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -18631,7 +18972,7 @@ paths: type: integer runners: type: array - items: &107 + items: &113 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18694,7 +19035,7 @@ paths: - size_gb - display_name - source - machine_size_details: &115 + machine_size_details: &121 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18803,7 +19144,7 @@ paths: - public_ip_enabled - platform examples: - default: &135 + default: &141 value: total_count: 2 runners: @@ -18845,7 +19186,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18863,7 +19204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -18941,9 +19282,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: &116 + default: &122 value: id: 5 name: My hosted ubuntu runner @@ -18984,7 +19325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -19000,7 +19341,7 @@ paths: type: integer images: type: array - items: &108 + items: &114 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -19059,7 +19400,7 @@ paths: - latest_version - state examples: - default: &110 + default: &116 value: total_count: 2 image_versions: @@ -19090,8 +19431,8 @@ paths: 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 - - &109 + - *65 + - &115 name: image_definition_id description: Image definition ID of custom image in: path @@ -19103,7 +19444,7 @@ paths: description: Response content: application/json: - schema: *108 + schema: *114 examples: default: value: @@ -19133,8 +19474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *61 - - *109 + - *65 + - *115 responses: '204': description: Response @@ -19157,8 +19498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *109 - - *61 + - *115 + - *65 responses: '200': description: Response @@ -19174,7 +19515,7 @@ paths: type: integer image_versions: type: array - items: &111 + items: &117 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -19212,7 +19553,7 @@ paths: - created_on - state_details examples: - default: *110 + default: *116 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19232,9 +19573,9 @@ paths: 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 - - *109 - - &112 + - *65 + - *115 + - &118 name: version description: Version of a custom image in: path @@ -19247,7 +19588,7 @@ paths: description: Response content: application/json: - schema: *111 + schema: *117 examples: default: value: @@ -19273,9 +19614,9 @@ paths: 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 - - *109 - - *112 + - *65 + - *115 + - *118 responses: '204': description: Response @@ -19296,7 +19637,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: - - *61 + - *65 responses: '200': description: Response @@ -19312,7 +19653,7 @@ paths: type: integer images: type: array - items: &113 + items: &119 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -19352,7 +19693,7 @@ paths: - display_name - source examples: - default: &114 + default: &120 value: id: ubuntu-20.04 platform: linux-x64 @@ -19376,7 +19717,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: - - *61 + - *65 responses: '200': description: Response @@ -19392,9 +19733,9 @@ paths: type: integer images: type: array - items: *113 + items: *119 examples: - default: *114 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19411,7 +19752,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: - - *61 + - *65 responses: '200': description: Response @@ -19466,7 +19807,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: - - *61 + - *65 responses: '200': description: Response @@ -19482,7 +19823,7 @@ paths: type: integer machine_specs: type: array - items: *115 + items: *121 examples: default: value: @@ -19507,7 +19848,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: - - *61 + - *65 responses: '200': description: Response @@ -19551,8 +19892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *61 - - &117 + - *65 + - &123 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -19564,11 +19905,11 @@ paths: description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: *116 + default: *122 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19586,8 +19927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *61 - - *117 + - *65 + - *123 requestBody: required: true content: @@ -19631,9 +19972,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: *116 + default: *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19649,16 +19990,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *61 - - *117 + - *65 + - *123 responses: '202': description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: *116 + default: *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -19678,13 +20019,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: - - *61 + - *65 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &118 + schema: &124 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19698,7 +20039,7 @@ paths: required: - include_claim_keys examples: - default: &119 + default: &125 value: include_claim_keys: - repo @@ -19720,20 +20061,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: - - *61 + - *65 requestBody: required: true content: application/json: - schema: *118 + schema: *124 examples: - default: *119 + default: *125 responses: '201': description: Empty response content: application/json: - schema: &145 + schema: &151 title: Empty Object description: An object without any properties. type: object @@ -19763,7 +20104,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -19772,7 +20113,7 @@ paths: schema: type: object properties: - enabled_repositories: &120 + enabled_repositories: &126 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19785,7 +20126,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: &121 + allowed_actions: &127 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19793,12 +20134,12 @@ paths: - all - local_only - selected - selected_actions_url: &329 + selected_actions_url: &333 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: &122 + sha_pinning_required: &128 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19829,7 +20170,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -19840,9 +20181,9 @@ paths: schema: type: object properties: - enabled_repositories: *120 - allowed_actions: *121 - sha_pinning_required: *122 + enabled_repositories: *126 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled_repositories examples: @@ -19870,13 +20211,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &333 + schema: &337 type: object properties: days: @@ -19913,12 +20254,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: application/json: - schema: &334 + schema: &338 type: object properties: days: @@ -19935,7 +20276,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -19955,13 +20296,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &123 + schema: &129 type: object properties: approval_policy: @@ -19975,7 +20316,7 @@ paths: required: - approval_policy examples: - default: &335 + default: &339 value: approval_policy: first_time_contributors '404': *6 @@ -19996,7 +20337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -20006,7 +20347,7 @@ paths: required: true content: application/json: - schema: *123 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -20028,13 +20369,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: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 type: object required: - run_workflows_from_fork_pull_requests @@ -20060,7 +20401,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &124 + default: &130 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -20083,12 +20424,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: - - *61 + - *65 requestBody: required: true content: application/json: - schema: &337 + schema: &341 type: object required: - run_workflows_from_fork_pull_requests @@ -20111,7 +20452,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *124 + default: *130 responses: '204': description: Empty response for successful settings update @@ -20141,7 +20482,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: - - *61 + - *65 - *17 - *19 responses: @@ -20159,9 +20500,9 @@ paths: type: number repositories: type: array - items: *64 + items: *68 examples: - default: &128 + default: &134 value: total_count: 1 repositories: @@ -20301,7 +20642,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: - - *61 + - *65 responses: '204': description: Response @@ -20345,8 +20686,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: - - *61 - - &125 + - *65 + - &131 name: repository_id description: The unique identifier of the repository. in: path @@ -20374,8 +20715,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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: Response @@ -20398,13 +20739,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &126 + schema: &132 type: object properties: github_owned_allowed: @@ -20426,7 +20767,7 @@ paths: items: type: string examples: - default: &127 + default: &133 value: github_owned_allowed: true verified_allowed: false @@ -20451,7 +20792,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -20459,9 +20800,9 @@ paths: required: false content: application/json: - schema: *126 + schema: *132 examples: - selected_actions: *127 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20481,7 +20822,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -20529,7 +20870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -20556,7 +20897,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -20576,7 +20917,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: - - *61 + - *65 - *17 - *19 responses: @@ -20591,9 +20932,9 @@ paths: type: integer repositories: type: array - items: *64 + items: *68 examples: - default: *128 + default: *134 '403': *27 '404': *6 x-github: @@ -20613,7 +20954,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: - - *61 + - *65 requestBody: required: true content: @@ -20661,14 +21002,14 @@ 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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -20688,14 +21029,14 @@ 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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -20717,23 +21058,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &338 + schema: &342 type: object properties: - default_workflow_permissions: &129 + default_workflow_permissions: &135 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &130 + can_approve_pull_request_reviews: &136 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20741,7 +21082,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &131 + default: &137 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20766,7 +21107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Success response @@ -20774,13 +21115,13 @@ paths: required: false content: application/json: - schema: &339 + schema: &343 type: object properties: - default_workflow_permissions: *129 - can_approve_pull_request_reviews: *130 + default_workflow_permissions: *135 + can_approve_pull_request_reviews: *136 examples: - default: *131 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20800,7 +21141,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: - - *61 + - *65 - *17 - *19 - name: visible_to_repository @@ -20825,7 +21166,7 @@ paths: type: number runner_groups: type: array - items: &132 + items: &138 type: object properties: id: @@ -20942,7 +21283,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: - - *61 + - *65 requestBody: required: true content: @@ -21015,9 +21356,9 @@ paths: description: Response content: application/json: - schema: *132 + schema: *138 examples: - default: &134 + default: &140 value: id: 2 name: octo-runner-group @@ -21052,8 +21393,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: - - *61 - - &133 + - *65 + - &139 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -21065,7 +21406,7 @@ paths: description: Response content: application/json: - schema: *132 + schema: *138 examples: default: value: @@ -21101,8 +21442,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: - - *61 - - *133 + - *65 + - *139 requestBody: required: true content: @@ -21158,9 +21499,9 @@ paths: description: Response content: application/json: - schema: *132 + schema: *138 examples: - default: *134 + default: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21179,8 +21520,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: - - *61 - - *133 + - *65 + - *139 responses: '204': description: Response @@ -21203,8 +21544,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: - - *61 - - *133 + - *65 + - *139 - *17 - *19 responses: @@ -21222,11 +21563,11 @@ paths: type: number runners: type: array - items: *107 + items: *113 examples: - default: *135 + default: *141 headers: - Link: *52 + Link: *56 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21246,8 +21587,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: - - *61 - - *133 + - *65 + - *139 - *19 - *17 responses: @@ -21265,9 +21606,9 @@ paths: type: number repositories: type: array - items: *136 + items: *142 examples: - default: &642 + default: &644 value: total_count: 1 repositories: @@ -21519,8 +21860,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: - - *61 - - *133 + - *65 + - *139 requestBody: required: true content: @@ -21564,9 +21905,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: - - *61 - - *133 - - *125 + - *65 + - *139 + - *131 responses: '204': description: Response @@ -21588,9 +21929,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: - - *61 - - *133 - - *125 + - *65 + - *139 + - *131 responses: '204': description: Response @@ -21613,8 +21954,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: - - *61 - - *133 + - *65 + - *139 - *17 - *19 responses: @@ -21632,7 +21973,7 @@ paths: type: number runners: type: array - items: &138 + items: &144 title: Self hosted runners description: A self hosted runner type: object @@ -21666,7 +22007,7 @@ paths: type: boolean labels: type: array - items: &141 + items: &147 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -21696,7 +22037,7 @@ paths: - busy - labels examples: - default: &139 + default: &145 value: total_count: 2 runners: @@ -21736,7 +22077,7 @@ paths: name: no-gpu type: custom headers: - Link: *52 + Link: *56 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21755,8 +22096,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: - - *61 - - *133 + - *65 + - *139 requestBody: required: true content: @@ -21800,9 +22141,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: - - *61 - - *133 - - &137 + - *65 + - *139 + - &143 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21830,9 +22171,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: - - *61 - - *133 - - *137 + - *65 + - *139 + - *143 responses: '204': description: Response @@ -21862,7 +22203,7 @@ paths: in: query schema: type: string - - *61 + - *65 - *17 - *19 responses: @@ -21880,11 +22221,11 @@ paths: type: integer runners: type: array - items: *138 + items: *144 examples: - default: *139 + default: *145 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21906,7 +22247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -21914,7 +22255,7 @@ paths: application/json: schema: type: array - items: &340 + items: &344 title: Runner Application description: Runner Application type: object @@ -21939,7 +22280,7 @@ paths: - download_url - filename examples: - default: &341 + default: &345 value: - os: osx architecture: x64 @@ -21982,7 +22323,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: - - *61 + - *65 requestBody: required: true content: @@ -22025,7 +22366,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &342 + '201': &346 description: Response content: application/json: @@ -22035,7 +22376,7 @@ paths: - runner - encoded_jit_config properties: - runner: *138 + runner: *144 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -22064,7 +22405,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22092,13 +22433,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *61 + - *65 responses: '201': description: Response content: application/json: - schema: &140 + schema: &146 title: Authentication Token description: Authentication Token type: object @@ -22122,7 +22463,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *64 + items: *68 single_file: type: - string @@ -22140,7 +22481,7 @@ paths: - token - expires_at examples: - default: &343 + default: &347 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -22171,15 +22512,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *61 + - *65 responses: '201': description: Response content: application/json: - schema: *140 + schema: *146 examples: - default: &344 + default: &348 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -22204,16 +22545,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: - - *61 - - *137 + - *65 + - *143 responses: '200': description: Response content: application/json: - schema: *138 + schema: *144 examples: - default: &345 + default: &349 value: id: 23 name: MBP @@ -22254,8 +22595,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: - - *61 - - *137 + - *65 + - *143 responses: '204': description: Response @@ -22281,10 +22622,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: - - *61 - - *137 + - *65 + - *143 responses: - '200': &142 + '200': &148 description: Response content: application/json: @@ -22298,7 +22639,7 @@ paths: type: integer labels: type: array - items: *141 + items: *147 examples: default: value: @@ -22337,8 +22678,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: - - *61 - - *137 + - *65 + - *143 requestBody: required: true content: @@ -22362,7 +22703,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -22386,8 +22727,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: - - *61 - - *137 + - *65 + - *143 requestBody: required: true content: @@ -22412,7 +22753,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -22436,10 +22777,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: - - *61 - - *137 + - *65 + - *143 responses: - '200': &346 + '200': &350 description: Response content: application/json: @@ -22453,7 +22794,7 @@ paths: type: integer labels: type: array - items: *141 + items: *147 examples: default: value: @@ -22494,9 +22835,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: - - *61 - - *137 - - &347 + - *65 + - *143 + - &351 name: name description: The name of a self-hosted runner's custom label. in: path @@ -22504,7 +22845,7 @@ paths: schema: type: string responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -22529,7 +22870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *61 + - *65 - *17 - *19 responses: @@ -22547,7 +22888,7 @@ paths: type: integer secrets: type: array - items: &143 + items: &149 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22599,7 +22940,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22622,13 +22963,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &359 + schema: &363 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22663,7 +23004,7 @@ paths: - key_id - key examples: - default: &360 + default: &364 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22688,8 +23029,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *61 - - &144 + - *65 + - &150 name: secret_name description: The name of the secret. in: path @@ -22701,7 +23042,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *149 examples: default: value: @@ -22731,8 +23072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -22789,7 +23130,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -22815,8 +23156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -22842,8 +23183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - *19 - *17 responses: @@ -22861,9 +23202,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: &148 + default: &154 value: total_count: 1 repositories: @@ -22955,8 +23296,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -23008,8 +23349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -23042,8 +23383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -23075,8 +23416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *61 - - &328 + - *65 + - &332 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)." @@ -23100,7 +23441,7 @@ paths: type: integer variables: type: array - items: &146 + items: &152 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23169,7 +23510,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23190,7 +23531,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *61 + - *65 requestBody: required: true content: @@ -23238,7 +23579,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -23263,8 +23604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *61 - - &147 + - *65 + - &153 name: name description: The name of the variable. in: path @@ -23276,7 +23617,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *152 examples: default: value: @@ -23306,8 +23647,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 requestBody: required: true content: @@ -23369,8 +23710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 responses: '204': description: Response @@ -23396,8 +23737,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 - *19 - *17 responses: @@ -23415,9 +23756,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23443,8 +23784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 requestBody: required: true content: @@ -23493,8 +23834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 - name: repository_id in: path required: true @@ -23528,8 +23869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 - name: repository_id in: path required: true @@ -23559,7 +23900,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *61 + - *65 requestBody: required: true content: @@ -23669,7 +24010,7 @@ paths: type: integer deployment_records: type: array - items: &149 + items: &155 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -23714,7 +24055,7 @@ paths: description: The ID of the provenance attestation associated with the deployment record. examples: - default: &150 + default: &156 value: total_count: 1 deployment_records: @@ -23745,7 +24086,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *61 + - *65 - name: cluster in: path description: The cluster name. @@ -23862,9 +24203,9 @@ paths: type: integer deployment_records: type: array - items: *149 + items: *155 examples: - default: *150 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23884,7 +24225,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *61 + - *65 requestBody: required: true content: @@ -24047,7 +24388,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *61 + - *65 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -24073,9 +24414,9 @@ paths: - 3 deployment_records: type: array - items: *149 + items: *155 examples: - default: *150 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24095,7 +24436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *61 + - *65 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24179,9 +24520,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *38 - - *39 - - *61 + - *43 + - *44 + - *65 requestBody: required: true content: @@ -24205,12 +24546,12 @@ paths: required: - subject_digests examples: - default: &669 + default: &671 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &670 + withPredicateType: &672 value: subject_digests: - sha256:abc123 @@ -24269,7 +24610,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &671 + default: &673 value: attestations_subject_digests: - sha256:abc: @@ -24378,7 +24719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *61 + - *65 requestBody: required: true content: @@ -24443,7 +24784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *61 + - *65 - name: subject_digest description: Subject Digest in: path @@ -24476,9 +24817,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories parameters: - *17 - - *38 - - *39 - - *61 + - *43 + - *44 + - *65 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -24526,7 +24867,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *61 + - *65 - name: attestation_id description: Attestation ID in: path @@ -24562,9 +24903,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations parameters: - *17 - - *38 - - *39 - - *61 + - *43 + - *44 + - *65 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24618,7 +24959,7 @@ paths: initiator: type: string examples: - default: &373 + default: &377 value: attestations: - bundle: @@ -24725,7 +25066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -24737,7 +25078,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24756,8 +25097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: If the user is blocked @@ -24782,8 +25123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -24803,8 +25144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -24829,15 +25170,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *61 + - *65 - *19 - *17 - - *46 + - *50 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &151 + schema: &157 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -24863,7 +25204,7 @@ paths: application/json: schema: type: array - items: &152 + items: &158 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24894,7 +25235,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &172 + items: &178 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24971,7 +25312,7 @@ paths: parent: anyOf: - type: 'null' - - &223 + - &229 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -25107,7 +25448,7 @@ paths: - string - 'null' format: date-time - state: *151 + state: *157 contact_link: description: The contact link of the campaign. type: @@ -25203,9 +25544,9 @@ paths: closed_at: state: open headers: - Link: *52 + Link: *56 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25229,7 +25570,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -25330,9 +25671,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: - default: &153 + default: &159 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -25381,7 +25722,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25403,7 +25744,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *61 + - *65 - name: campaign_number description: The campaign number. in: path @@ -25415,16 +25756,16 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: - default: *153 + default: *159 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25445,7 +25786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *61 + - *65 - name: campaign_number description: The campaign number. in: path @@ -25495,7 +25836,7 @@ paths: - string - 'null' format: uri - state: *151 + state: *157 examples: default: value: @@ -25505,9 +25846,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: - default: *153 + default: *159 '400': description: Bad Request content: @@ -25519,7 +25860,7 @@ paths: content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25540,7 +25881,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *61 + - *65 - name: campaign_number description: The campaign number. in: path @@ -25551,7 +25892,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25573,18 +25914,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *61 - - &398 + - *65 + - &402 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: &161 + schema: &167 type: string description: The name of the tool used to generate the code scanning analysis. - - &399 + - &403 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 @@ -25592,23 +25933,23 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &162 + schema: &168 type: - string - 'null' description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *38 - - *39 + - *43 + - *44 - *19 - *17 - - *46 + - *50 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &401 + schema: &405 type: string description: State of a code scanning alert. enum: @@ -25631,7 +25972,7 @@ paths: be returned. in: query required: false - schema: &402 + schema: &406 type: string description: Severity of a code scanning alert. enum: @@ -25652,18 +25993,18 @@ paths: items: type: object properties: - number: *154 - created_at: *155 - updated_at: *156 - url: *157 - html_url: *158 - instances_url: &403 + number: *160 + created_at: *161 + updated_at: *162 + url: *163 + html_url: *164 + instances_url: &407 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &163 + state: &169 type: - string - 'null' @@ -25673,13 +26014,13 @@ paths: - dismissed - fixed - - fixed_at: *159 + fixed_at: *165 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *160 - dismissed_reason: &404 + dismissed_at: *166 + dismissed_reason: &408 type: - string - 'null' @@ -25690,14 +26031,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &405 + dismissed_comment: &409 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &406 + rule: &410 type: object properties: id: @@ -25758,26 +26099,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &407 + tool: &411 type: object properties: - name: *161 + name: *167 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *162 - most_recent_instance: &408 + guid: *168 + most_recent_instance: &412 type: object properties: - ref: &400 + ref: &404 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &418 + analysis_key: &422 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -25788,13 +26129,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &419 + category: &423 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: *163 + state: *169 commit_sha: type: string message: @@ -25835,7 +26176,7 @@ paths: - test - library - - repository: *51 + repository: *55 dismissal_approved_by: anyOf: - type: 'null' @@ -26087,9 +26428,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: *52 + Link: *56 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26111,7 +26452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *61 + - *65 - name: target_type in: query description: The target type of the code security configuration @@ -26130,8 +26471,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -26139,7 +26480,7 @@ paths: application/json: schema: type: array - items: *41 + items: *45 examples: default: value: @@ -26222,7 +26563,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *61 + - *65 requestBody: required: true content: @@ -26300,7 +26641,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *164 + code_scanning_options: *170 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -26309,7 +26650,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *44 + code_scanning_default_setup_options: *48 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -26441,9 +26782,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *41 + schema: *45 examples: - default: *165 + default: *171 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26465,15 +26806,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *166 + schema: *172 examples: - default: *167 + default: *173 '304': *35 '403': *27 '404': *6 @@ -26499,7 +26840,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *61 + - *65 requestBody: required: true content: @@ -26525,11 +26866,11 @@ paths: - 32 - 91 responses: - '204': *168 + '204': *174 '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26551,16 +26892,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 responses: '200': description: Response content: application/json: - schema: *41 + schema: *45 examples: - default: *165 + default: *171 '304': *35 '403': *27 '404': *6 @@ -26584,8 +26925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 requestBody: required: true content: @@ -26664,7 +27005,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *44 + code_scanning_default_setup_options: *48 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -26782,7 +27123,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *41 + schema: *45 examples: default: value: @@ -26841,14 +27182,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 responses: - '204': *168 + '204': *174 '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26872,8 +27213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *61 - - *43 + - *65 + - *47 requestBody: required: true content: @@ -26936,8 +27277,8 @@ 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: - - *61 - - *43 + - *65 + - *47 requestBody: required: true content: @@ -26977,12 +27318,12 @@ paths: - none - private_and_internal - public - configuration: *41 + configuration: *45 examples: default: value: default_for_new_repos: all - configuration: *165 + configuration: *171 '403': *27 '404': *6 x-github: @@ -27006,8 +27347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 - 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)." @@ -27016,8 +27357,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -27035,13 +27376,13 @@ paths: application/json: schema: type: array - items: *169 + items: *175 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *170 + repository: *176 '403': *27 '404': *6 x-github: @@ -27065,7 +27406,7 @@ paths: parameters: - *17 - *19 - - *61 + - *65 responses: '200': description: Response @@ -27081,7 +27422,7 @@ paths: type: integer codespaces: type: array - items: &213 + items: &219 type: object title: Codespace description: A codespace. @@ -27112,11 +27453,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *136 + repository: *142 machine: anyOf: - type: 'null' - - &431 + - &435 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -27403,7 +27744,7 @@ paths: - pulls_url - recent_folders examples: - default: &214 + default: &220 value: total_count: 3 codespaces: @@ -27813,7 +28154,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -27835,7 +28176,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *61 + - *65 deprecated: true requestBody: required: true @@ -27879,7 +28220,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27902,7 +28243,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *61 + - *65 deprecated: true requestBody: required: true @@ -27934,7 +28275,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27957,7 +28298,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *61 + - *65 requestBody: required: true content: @@ -27988,7 +28329,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28009,7 +28350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *61 + - *65 - *17 - *19 responses: @@ -28027,7 +28368,7 @@ paths: type: integer secrets: type: array - items: &171 + items: &177 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -28068,7 +28409,7 @@ paths: - updated_at - visibility examples: - default: &432 + default: &436 value: total_count: 2 secrets: @@ -28081,7 +28422,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28100,13 +28441,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &433 + schema: &437 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -28141,7 +28482,7 @@ paths: - key_id - key examples: - default: &434 + default: &438 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28164,23 +28505,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '200': description: Response content: application/json: - schema: *171 + schema: *177 examples: - default: &436 + default: &440 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28200,8 +28541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -28256,7 +28597,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -28282,8 +28623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -28308,8 +28649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - *19 - *17 responses: @@ -28327,9 +28668,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 '404': *6 x-github: githubCloudOnly: false @@ -28351,8 +28692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -28402,8 +28743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -28436,8 +28777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -28476,7 +28817,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: - - *61 + - *65 responses: '200': description: OK @@ -28585,7 +28926,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28617,7 +28958,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: - - *61 + - *65 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -28640,7 +28981,7 @@ paths: currently being billed. seats: type: array - items: &216 + items: &222 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -28653,13 +28994,13 @@ paths: organization: anyOf: - type: 'null' - - *59 + - *63 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *172 - - *53 + - *178 + - *57 type: - 'null' - object @@ -28789,8 +29130,8 @@ paths: type: User site_admin: false headers: - Link: *52 - '500': *96 + Link: *56 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28823,7 +29164,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: - - *61 + - *65 requestBody: content: application/json: @@ -28865,7 +29206,7 @@ paths: default: value: seats_created: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28901,7 +29242,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: - - *61 + - *65 requestBody: content: application/json: @@ -28943,7 +29284,7 @@ paths: default: value: seats_cancelled: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28981,7 +29322,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: - - *61 + - *65 requestBody: content: application/json: @@ -29022,7 +29363,7 @@ paths: default: value: seats_created: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -29058,7 +29399,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: - - *61 + - *65 requestBody: content: application/json: @@ -29100,7 +29441,7 @@ paths: default: value: seats_cancelled: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -29139,7 +29480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *61 + - *65 - 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`). @@ -29171,7 +29512,7 @@ paths: application/json: schema: type: array - items: &293 + items: &300 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -29486,7 +29827,7 @@ paths: - date additionalProperties: true examples: - default: &294 + default: &301 value: - date: '2024-06-24' total_active_users: 24 @@ -29585,10 +29926,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *96 + '500': *102 '403': *27 '404': *6 - '422': &295 + '422': &302 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -29615,12 +29956,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *61 - - *173 - - *174 - - *175 - - *176 - - *177 + - *65 + - *179 + - *180 + - *181 + - *182 + - *183 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -29658,11 +29999,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *178 - - *179 - - *46 - - *38 - - *39 + - *184 + - *185 + - *50 + - *43 + - *44 - *17 responses: '200': @@ -29671,9 +30012,9 @@ paths: application/json: schema: type: array - items: *180 + items: *186 examples: - default: *181 + default: *187 '304': *35 '400': *14 '403': *27 @@ -29699,7 +30040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *61 + - *65 - *17 - *19 responses: @@ -29717,7 +30058,7 @@ paths: type: integer secrets: type: array - items: &182 + items: &188 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29769,7 +30110,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29790,13 +30131,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &459 + schema: &463 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -29815,7 +30156,7 @@ paths: - key_id - key examples: - default: &460 + default: &464 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29838,14 +30179,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '200': description: Response content: application/json: - schema: *182 + schema: *188 examples: default: value: @@ -29873,8 +30214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -29933,7 +30274,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -29957,8 +30298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -29982,8 +30323,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - *19 - *17 responses: @@ -30001,9 +30342,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30024,8 +30365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -30075,8 +30416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -30107,8 +30448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -30138,7 +30479,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: - - *61 + - *65 responses: '200': description: Response @@ -30146,7 +30487,7 @@ paths: application/json: schema: type: array - items: &225 + items: &231 title: Package description: A software package type: object @@ -30199,7 +30540,7 @@ paths: repository: anyOf: - type: 'null' - - *136 + - *142 created_at: type: string format: date-time @@ -30217,7 +30558,7 @@ paths: - created_at - updated_at examples: - default: &226 + default: &232 value: - id: 197 name: hello_docker @@ -30295,7 +30636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *61 + - *65 - *17 - *19 responses: @@ -30305,7 +30646,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: 200-response: value: @@ -30377,7 +30718,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *61 + - *65 - *17 - *19 responses: @@ -30387,7 +30728,7 @@ paths: application/json: schema: type: array - items: &205 + items: &211 title: Organization Invitation description: Organization Invitation type: object @@ -30441,7 +30782,7 @@ paths: - invitation_teams_url - node_id examples: - default: &206 + default: &212 value: - id: 1 login: monalisa @@ -30474,7 +30815,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -30498,7 +30839,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *61 + - *65 - *17 - *19 responses: @@ -30508,7 +30849,7 @@ paths: application/json: schema: type: array - items: &183 + items: &189 title: Org Hook description: Org Hook type: object @@ -30608,7 +30949,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -30631,7 +30972,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *61 + - *65 requestBody: required: true content: @@ -30693,9 +31034,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *189 examples: - default: &184 + default: &190 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30742,8 +31083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *61 - - &185 + - *65 + - &191 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. @@ -30756,9 +31097,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *189 examples: - default: *184 + default: *190 '404': *6 x-github: githubCloudOnly: false @@ -30785,8 +31126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 requestBody: required: false content: @@ -30832,7 +31173,7 @@ paths: description: Response content: application/json: - schema: *183 + schema: *189 examples: default: value: @@ -30873,8 +31214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 responses: '204': description: Response @@ -30901,8 +31242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *61 - - *185 + - *65 + - *191 responses: '200': description: Response @@ -30932,8 +31273,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *61 - - *185 + - *65 + - *191 requestBody: required: false content: @@ -30983,10 +31324,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 - *17 - - *186 + - *192 responses: '200': description: Response @@ -30994,9 +31335,9 @@ paths: application/json: schema: type: array - items: *187 + items: *193 examples: - default: *188 + default: *194 '400': *14 '422': *15 x-github: @@ -31021,17 +31362,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 - *16 responses: '200': description: Response content: application/json: - schema: *189 + schema: *195 examples: - default: *190 + default: *196 '400': *14 '422': *15 x-github: @@ -31056,8 +31397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 - *16 responses: '202': *37 @@ -31086,8 +31427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 responses: '204': description: Response @@ -31109,8 +31450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *61 - - &195 + - *65 + - &201 name: actor_type in: path description: The type of the actor @@ -31123,14 +31464,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &196 + - &202 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &191 + - &197 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`.' @@ -31138,7 +31479,7 @@ paths: required: true schema: type: string - - &192 + - &198 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) @@ -31149,7 +31490,7 @@ paths: type: string - *19 - *17 - - *46 + - *50 - name: sort description: The property to sort the results by. in: query @@ -31232,13 +31573,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *61 - - *191 - - *192 + - *65 + - *197 + - *198 - *19 - *17 - - *46 - - &201 + - *50 + - &207 name: sort description: The property to sort the results by. in: query @@ -31317,15 +31658,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *61 - - *191 - - *192 + - *65 + - *197 + - *198 responses: '200': description: Response content: application/json: - schema: &193 + schema: &199 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -31341,7 +31682,7 @@ paths: type: integer format: int64 examples: - default: &194 + default: &200 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -31361,24 +31702,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *61 - - &197 + - *65 + - &203 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *191 - - *192 + - *197 + - *198 responses: '200': description: Response content: application/json: - schema: *193 + schema: *199 examples: - default: *194 + default: *200 x-github: enabledForGitHubApps: true category: orgs @@ -31396,19 +31737,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *61 - - *191 - - *192 - - *195 - - *196 + - *65 + - *197 + - *198 + - *201 + - *202 responses: '200': description: Response content: application/json: - schema: *193 + schema: *199 examples: - default: *194 + default: *200 x-github: enabledForGitHubApps: true category: orgs @@ -31425,10 +31766,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *61 - - *191 - - *192 - - &198 + - *65 + - *197 + - *198 + - &204 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -31441,7 +31782,7 @@ paths: description: Response content: application/json: - schema: &199 + schema: &205 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -31457,7 +31798,7 @@ paths: type: integer format: int64 examples: - default: &200 + default: &206 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -31493,19 +31834,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *61 + - *65 + - *203 - *197 - - *191 - - *192 - *198 + - *204 responses: '200': description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: *200 + default: *206 x-github: enabledForGitHubApps: true category: orgs @@ -31522,20 +31863,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *61 - - *195 - - *196 - - *191 - - *192 + - *65 + - *201 + - *202 + - *197 - *198 + - *204 responses: '200': description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: *200 + default: *206 x-github: enabledForGitHubApps: true category: orgs @@ -31552,14 +31893,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *61 + - *65 + - *203 - *197 - - *191 - - *192 + - *198 - *19 - *17 - - *46 - - *201 + - *50 + - *207 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -31635,7 +31976,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *61 + - *65 responses: '200': description: Response @@ -31643,7 +31984,7 @@ paths: application/json: schema: *20 examples: - default: &498 + default: &502 value: id: 1 account: @@ -31712,7 +32053,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -31782,7 +32123,7 @@ paths: suspended_at: suspended_by: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31801,7 +32142,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -31809,12 +32150,12 @@ paths: application/json: schema: anyOf: - - &203 + - &209 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &202 + limit: &208 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -31842,7 +32183,7 @@ paths: properties: {} additionalProperties: false examples: - default: &204 + default: &210 value: limit: collaborators_only origin: organization @@ -31866,18 +32207,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: application/json: - schema: &499 + schema: &503 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *202 + limit: *208 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31902,9 +32243,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *209 examples: - default: *204 + default: *210 '422': *15 x-github: githubCloudOnly: false @@ -31922,7 +32263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -31946,7 +32287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *61 + - *65 - *17 - *19 - name: role @@ -31980,11 +32321,11 @@ paths: application/json: schema: type: array - items: *205 + items: *211 examples: - default: *206 + default: *212 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -32005,7 +32346,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *61 + - *65 requestBody: required: false content: @@ -32059,7 +32400,7 @@ paths: description: Response content: application/json: - schema: *205 + schema: *211 examples: default: value: @@ -32113,8 +32454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *61 - - &207 + - *65 + - &213 name: invitation_id description: The unique identifier of the invitation. in: path @@ -32144,8 +32485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *61 - - *207 + - *65 + - *213 - *17 - *19 responses: @@ -32155,9 +32496,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: &224 + default: &230 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -32173,7 +32514,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -32192,7 +32533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -32200,7 +32541,7 @@ paths: application/json: schema: type: array - items: *208 + items: *214 examples: default: value: @@ -32238,7 +32579,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -32288,9 +32629,9 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: - default: &209 + default: &215 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -32322,8 +32663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *61 - - &210 + - *65 + - &216 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -32379,9 +32720,9 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: - default: *209 + default: *215 '404': *6 '422': *7 x-github: @@ -32405,8 +32746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *61 - - *210 + - *65 + - *216 responses: '204': description: Response @@ -32439,7 +32780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *61 + - *65 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -32469,7 +32810,7 @@ paths: - closed - all default: open - - *211 + - *217 - name: type description: Can be the name of an issue type. in: query @@ -32487,8 +32828,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - *17 - *19 responses: @@ -32498,11 +32839,11 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *212 + default: *218 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -32522,7 +32863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *61 + - *65 - 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) @@ -32560,9 +32901,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -32580,8 +32921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response if requester is an organization member and user is @@ -32615,8 +32956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -32642,8 +32983,8 @@ paths: parameters: - *17 - *19 + - *65 - *61 - - *57 responses: '200': description: Response @@ -32659,11 +33000,11 @@ paths: type: integer codespaces: type: array - items: *213 + items: *219 examples: - default: *214 + default: *220 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32686,9 +33027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: + - *65 - *61 - - *57 - - &215 + - &221 name: codespace_name in: path required: true @@ -32698,7 +33039,7 @@ paths: responses: '202': *37 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32721,17 +33062,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: + - *65 - *61 - - *57 - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: &430 + default: &434 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32873,7 +33214,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32904,14 +33245,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: + - *65 - *61 - - *57 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *216 + schema: *222 examples: default: value: @@ -32955,7 +33296,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32980,14 +33321,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '200': description: Response content: application/json: - schema: &217 + schema: &223 title: Org Membership description: Org Membership type: object @@ -33036,7 +33377,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *59 + organization: *63 user: anyOf: - type: 'null' @@ -33056,7 +33397,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &218 + response-if-user-has-an-active-admin-membership-with-organization: &224 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -33124,8 +33465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 requestBody: required: false content: @@ -33153,9 +33494,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *223 examples: - response-if-user-already-had-membership-with-organization: *218 + response-if-user-already-had-membership-with-organization: *224 '422': *15 '403': *27 x-github: @@ -33179,8 +33520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -33205,7 +33546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *61 + - *65 - *17 - *19 - name: exclude @@ -33227,7 +33568,7 @@ paths: application/json: schema: type: array - items: &219 + items: &225 title: Migration description: A migration. type: object @@ -33269,7 +33610,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *64 + items: *68 url: type: string format: uri @@ -33468,7 +33809,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33484,7 +33825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *61 + - *65 requestBody: required: true content: @@ -33565,7 +33906,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -33743,8 +34084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *61 - - &220 + - *65 + - &226 name: migration_id description: The unique identifier of the migration. in: path @@ -33772,7 +34113,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -33941,8 +34282,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *61 - - *220 + - *65 + - *226 responses: '302': description: Response @@ -33963,8 +34304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *61 - - *220 + - *65 + - *226 responses: '204': description: Response @@ -33987,9 +34328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *61 - - *220 - - &654 + - *65 + - *226 + - &656 name: repo_name description: repo_name parameter in: path @@ -34016,8 +34357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *61 - - *220 + - *65 + - *226 - *17 - *19 responses: @@ -34027,9 +34368,9 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: &231 + default: &237 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -34140,7 +34481,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -34166,7 +34507,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response - list of organization roles @@ -34182,7 +34523,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &222 + items: &228 title: Organization Role description: Organization roles type: object @@ -34331,8 +34672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -34357,9 +34698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *61 - - *62 - - &221 + - *65 + - *66 + - &227 name: role_id description: The unique identifier of the role. in: path @@ -34394,9 +34735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *61 - - *62 - - *221 + - *65 + - *66 + - *227 responses: '204': description: Response @@ -34421,8 +34762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -34447,9 +34788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: + - *65 - *61 - - *57 - - *221 + - *227 responses: '204': description: Response @@ -34479,9 +34820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: + - *65 - *61 - - *57 - - *221 + - *227 responses: '204': description: Response @@ -34509,14 +34850,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *61 - - *221 + - *65 + - *227 responses: '200': description: Response content: application/json: - schema: *222 + schema: *228 examples: default: value: @@ -34566,8 +34907,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: - - *61 - - *221 + - *65 + - *227 - *17 - *19 responses: @@ -34646,7 +34987,7 @@ paths: parent: anyOf: - type: 'null' - - *223 + - *229 type: description: The ownership type of the team type: string @@ -34679,9 +35020,9 @@ paths: - type - parent examples: - default: *224 + default: *230 headers: - Link: *52 + Link: *56 '404': description: Response if the organization or role does not exist. '422': @@ -34708,8 +35049,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: - - *61 - - *221 + - *65 + - *227 - *17 - *19 responses: @@ -34738,7 +35079,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *223 + items: *229 name: type: - string @@ -34855,9 +35196,9 @@ paths: - type - url examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '404': description: Response if the organization or role does not exist. '422': @@ -34879,7 +35220,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *61 + - *65 - 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) @@ -34906,9 +35247,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34931,8 +35272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: + - *65 - *61 - - *57 requestBody: required: false content: @@ -34989,8 +35330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -35047,8 +35388,8 @@ paths: - docker - nuget - container - - *61 - - &655 + - *65 + - &657 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35084,12 +35425,12 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *226 + default: *232 '403': *27 '401': *23 - '400': &657 + '400': &659 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35111,7 +35452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &227 + - &233 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 @@ -35129,20 +35470,20 @@ paths: - docker - nuget - container - - &228 + - &234 name: package_name description: The name of the package. in: path required: true schema: type: string - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *225 + schema: *231 examples: default: value: @@ -35194,9 +35535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *227 - - *228 - - *61 + - *233 + - *234 + - *65 responses: '204': description: Response @@ -35228,9 +35569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *227 - - *228 - - *61 + - *233 + - *234 + - *65 - name: token description: package token schema: @@ -35262,9 +35603,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: - - *227 - - *228 - - *61 + - *233 + - *234 + - *65 - *19 - *17 - name: state @@ -35284,7 +35625,7 @@ paths: application/json: schema: type: array - items: &229 + items: &235 title: Package Version description: A version of a software package type: object @@ -35419,10 +35760,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *227 - - *228 - - *61 - - &230 + - *233 + - *234 + - *65 + - &236 name: package_version_id description: Unique identifier of the package version. in: path @@ -35434,7 +35775,7 @@ paths: description: Response content: application/json: - schema: *229 + schema: *235 examples: default: value: @@ -35470,10 +35811,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *227 - - *228 - - *61 - - *230 + - *233 + - *234 + - *65 + - *236 responses: '204': description: Response @@ -35505,10 +35846,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *227 - - *228 - - *61 - - *230 + - *233 + - *234 + - *65 + - *236 responses: '204': description: Response @@ -35535,10 +35876,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: - - *61 + - *65 - *17 - *19 - - &232 + - &238 name: sort description: The property by which to sort the results. in: query @@ -35548,8 +35889,8 @@ paths: enum: - created_at default: created_at - - *46 - - &233 + - *50 + - &239 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -35561,7 +35902,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &234 + - &240 name: repository description: The name of the repository to use to filter the results. in: query @@ -35570,7 +35911,7 @@ paths: type: string examples: - Hello-World - - &235 + - &241 name: permission description: The permission to use to filter the results. in: query @@ -35579,7 +35920,7 @@ paths: type: string examples: - issues_read - - &236 + - &242 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) @@ -35589,7 +35930,7 @@ paths: schema: type: string format: date-time - - &237 + - &243 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) @@ -35599,7 +35940,7 @@ paths: schema: type: string format: date-time - - &238 + - &244 name: token_id description: The ID of the token in: query @@ -35612,7 +35953,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 @@ -35747,7 +36088,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35767,7 +36108,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: - - *61 + - *65 requestBody: required: true content: @@ -35809,7 +36150,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 @@ -35834,7 +36175,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: - - *61 + - *65 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35871,11 +36212,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35896,7 +36237,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: - - *61 + - *65 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35907,7 +36248,7 @@ paths: - *17 - *19 responses: - '500': *96 + '500': *102 '404': *6 '403': *27 '200': @@ -35916,11 +36257,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35941,19 +36282,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: - - *61 + - *65 - *17 - *19 - - *232 - - *46 - - *233 - - *234 - - *235 - - *236 - - *237 - *238 + - *50 + - *239 + - *240 + - *241 + - *242 + - *243 + - *244 responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 @@ -36082,7 +36423,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36102,7 +36443,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: - - *61 + - *65 requestBody: required: true content: @@ -36137,7 +36478,7 @@ paths: - 1296269 - 1296280 responses: - '500': *96 + '500': *102 '404': *6 '202': *37 '403': *27 @@ -36162,7 +36503,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: - - *61 + - *65 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -36190,9 +36531,9 @@ paths: value: action: revoke responses: - '500': *96 + '500': *102 '404': *6 - '204': *168 + '204': *174 '403': *27 '422': *15 x-github: @@ -36214,7 +36555,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: - - *61 + - *65 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -36224,7 +36565,7 @@ paths: - *17 - *19 responses: - '500': *96 + '500': *102 '404': *6 '403': *27 '200': @@ -36233,11 +36574,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36259,7 +36600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -36277,7 +36618,7 @@ paths: type: integer configurations: type: array - items: &239 + items: &245 title: Organization private registry description: Private registry configuration for an organization type: object @@ -36360,7 +36701,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *52 + Link: *56 '400': *14 '404': *6 x-github: @@ -36382,7 +36723,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -36573,7 +36914,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &240 + org-private-registry-with-selected-visibility: &246 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -36614,7 +36955,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: - - *61 + - *65 responses: '200': description: Response @@ -36642,7 +36983,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -36664,16 +37005,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *61 - - *144 + - *65 + - *150 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *239 + schema: *245 examples: - default: *240 + default: *246 '404': *6 x-github: githubCloudOnly: false @@ -36694,8 +37035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -36800,8 +37141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -36824,15 +37165,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *61 + - *65 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *38 - - *39 + - *43 + - *44 - *17 responses: '200': @@ -36841,7 +37182,7 @@ paths: application/json: schema: type: array - items: &241 + items: &247 title: Projects v2 Project description: A projects v2 project type: object @@ -36915,7 +37256,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &728 + - &739 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -37000,7 +37341,7 @@ paths: - deleted_at - deleted_by examples: - default: &242 + default: &248 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -37083,7 +37424,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -37103,24 +37444,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &243 + - &249 name: project_number description: The project's number. in: path required: true schema: type: integer - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: - default: *242 + default: *248 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -37140,8 +37481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *61 - - *243 + - *65 + - *249 requestBody: required: true description: Details of the draft item to create in the project. @@ -37175,7 +37516,7 @@ paths: description: Response content: application/json: - schema: &248 + schema: &254 title: Projects v2 Item description: An item belonging to a project type: object @@ -37188,8 +37529,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *78 - - &443 + - *82 + - &447 title: Pull Request Simple description: Pull Request Simple type: object @@ -37309,7 +37650,7 @@ paths: milestone: anyOf: - type: 'null' - - *244 + - *250 active_lock_reason: type: - string @@ -37364,7 +37705,7 @@ paths: type: - array - 'null' - items: *172 + items: *178 head: type: object properties: @@ -37372,7 +37713,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: @@ -37392,7 +37733,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: @@ -37408,7 +37749,7 @@ paths: _links: type: object properties: - comments: &245 + comments: &251 title: Link description: Hypermedia Link type: object @@ -37417,13 +37758,13 @@ paths: type: string required: - href - commits: *245 - statuses: *245 - html: *245 - issue: *245 - review_comments: *245 - review_comment: *245 - self: *245 + commits: *251 + statuses: *251 + html: *251 + issue: *251 + review_comments: *251 + review_comment: *251 + self: *251 required: - comments - commits @@ -37433,8 +37774,8 @@ paths: - review_comments - review_comment - self - author_association: *65 - auto_merge: &544 + author_association: *69 + auto_merge: &548 title: Auto merge description: The status of auto merging a pull request. type: @@ -37536,7 +37877,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &247 + content_type: &253 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -37580,7 +37921,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &249 + draft_issue: &255 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -37654,11 +37995,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *243 - - *61 + - *249 + - *65 - *17 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -37666,7 +38007,7 @@ paths: application/json: schema: type: array - items: &246 + items: &252 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -37816,7 +38157,7 @@ paths: - updated_at - project_url examples: - default: &674 + default: &676 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37850,60 +38191,351 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - - id: 67891 - node_id: PVTF_lADOABCD9876543210 - name: Status - data_type: single_select - project_url: https://api.github.com/projects/67890 - options: - - id: option_4 - name: - html: Todo - raw: Todo - color: GRAY - description: - html: Items to be worked on - raw: Items to be worked on - - id: option_5 - name: - html: In Progress - raw: In Progress - color: BLUE - description: - html: Items currently being worked on - raw: Items currently being worked on - - id: option_6 - name: - html: Done - raw: Done - color: GREEN - description: - html: Completed items - raw: Completed items - created_at: '2022-04-29T10:30:00Z' - updated_at: '2022-04-29T10:30:00Z' - - id: 24680 - node_id: PVTF_lADOABCD2468024680 - name: Team notes - data_type: text - project_url: https://api.github.com/projects/67890 - created_at: '2022-05-15T08:00:00Z' - updated_at: '2022-05-15T08:00:00Z' - - id: 13579 - node_id: PVTF_lADOABCD1357913579 - name: Story points - data_type: number - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-01T14:30:00Z' - updated_at: '2022-06-01T14:30:00Z' - - id: 98765 - node_id: PVTF_lADOABCD9876598765 - name: Due date - data_type: date - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-10T09:15:00Z' - updated_at: '2022-06-10T09:15:00Z' - - id: 11223 + - id: 67891 + node_id: PVTF_lADOABCD9876543210 + name: Status + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_4 + name: + html: Todo + raw: Todo + color: GRAY + description: + html: Items to be worked on + raw: Items to be worked on + - id: option_5 + name: + html: In Progress + raw: In Progress + color: BLUE + description: + html: Items currently being worked on + raw: Items currently being worked on + - id: option_6 + name: + html: Done + raw: Done + color: GREEN + description: + html: Completed items + raw: Completed items + created_at: '2022-04-29T10:30:00Z' + updated_at: '2022-04-29T10:30:00Z' + - id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + - id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + - id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + - id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + headers: + Link: *56 + '304': *35 + '403': *27 + '401': *23 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - *249 + - *65 + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + required: + - issue_field_id + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: &677 + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: &678 + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. + Individual iterations can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: &679 + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: &680 + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: *252 + examples: + text_field: &681 + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: &682 + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: &683 + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: &684 + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: &685 + value: + id: 11223 node_id: PVTF_lADOABCD1122311223 name: Sprint data_type: iteration @@ -37926,11 +38558,10 @@ paths: duration: 14 created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' - headers: - Link: *52 '304': *35 '403': *27 '401': *23 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37947,23 +38578,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *243 - - &675 + - *249 + - &686 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *246 + schema: *252 examples: - default: &676 + default: &687 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37972,21 +38603,33 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -38007,8 +38650,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *243 - - *61 + - *249 + - *65 - 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. @@ -38030,8 +38673,8 @@ paths: maxItems: 50 items: type: string - - *38 - - *39 + - *43 + - *44 - *17 responses: '200': @@ -38040,7 +38683,7 @@ paths: application/json: schema: type: array - items: &250 + items: &256 title: Projects v2 Item description: An item belonging to a project type: object @@ -38057,7 +38700,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: *247 + content_type: *253 content: type: - object @@ -38107,7 +38750,7 @@ paths: - updated_at - archived_at examples: - default: &251 + default: &257 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -38783,7 +39426,7 @@ paths: type: sub_issues_progress value: headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -38803,8 +39446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *61 - - *243 + - *65 + - *249 requestBody: required: true description: Details of the item to add to the project. @@ -38841,10 +39484,10 @@ paths: description: Response content: application/json: - schema: *248 + schema: *254 examples: - issue: *249 - pull_request: *249 + issue: *255 + pull_request: *255 '304': *35 '403': *27 '401': *23 @@ -38864,9 +39507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *243 - - *61 - - &252 + - *249 + - *65 + - &258 name: item_id description: The unique identifier of the project item. in: path @@ -38892,11 +39535,11 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - default: *251 + default: *257 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -38915,9 +39558,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *243 - - *61 - - *252 + - *249 + - *65 + - *258 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -38990,13 +39633,13 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - text_field: *251 - number_field: *251 - date_field: *251 - single_select_field: *251 - iteration_field: *251 + text_field: *257 + number_field: *257 + date_field: *257 + single_select_field: *257 + iteration_field: *257 '401': *23 '403': *27 '404': *6 @@ -39016,9 +39659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *243 - - *61 - - *252 + - *249 + - *65 + - *258 responses: '204': description: Response @@ -39042,7 +39685,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -39050,7 +39693,7 @@ paths: application/json: schema: type: array - items: &253 + items: &259 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -39124,7 +39767,7 @@ paths: - property_name - value_type examples: - default: &254 + default: &260 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39172,7 +39815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -39183,7 +39826,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *253 + items: *259 minItems: 1 maxItems: 100 required: @@ -39213,9 +39856,9 @@ paths: application/json: schema: type: array - items: *253 + items: *259 examples: - default: *254 + default: *260 '403': *27 '404': *6 x-github: @@ -39236,8 +39879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *61 - - &255 + - *65 + - &261 name: custom_property_name description: The custom property name in: path @@ -39249,9 +39892,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: &256 + default: &262 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39285,8 +39928,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: - - *61 - - *255 + - *65 + - *261 requestBody: required: true content: @@ -39362,9 +40005,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: *256 + default: *262 '403': *27 '404': *6 x-github: @@ -39387,10 +40030,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *61 - - *255 + - *65 + - *261 responses: - '204': *168 + '204': *174 '403': *27 '404': *6 x-github: @@ -39411,7 +40054,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *61 + - *65 - *17 - *19 - name: repository_query @@ -39452,7 +40095,7 @@ paths: - octocat/Hello-World properties: type: array - items: *95 + items: *101 description: List of custom property names and associated values required: - repository_id @@ -39473,7 +40116,7 @@ paths: - property_name: team value: octocat headers: - Link: *52 + Link: *56 '403': *27 '404': *6 x-github: @@ -39501,7 +40144,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: - - *61 + - *65 requestBody: required: true content: @@ -39521,7 +40164,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *95 + items: *101 required: - repository_names - properties @@ -39562,7 +40205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *61 + - *65 - *17 - *19 responses: @@ -39574,9 +40217,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39593,8 +40236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response if user is a public member @@ -39618,8 +40261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -39640,8 +40283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -39665,7 +40308,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *61 + - *65 - name: type description: Specifies the types of repositories you want returned. in: query @@ -39711,11 +40354,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39734,7 +40377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *61 + - *65 requestBody: required: true content: @@ -39916,7 +40559,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &319 title: Full Repository description: Full Repository type: object @@ -40262,7 +40905,7 @@ paths: template_repository: anyOf: - type: 'null' - - *64 + - *68 temp_clone_token: type: - string @@ -40362,13 +41005,13 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 organization: anyOf: - type: 'null' - *4 - parent: *64 - source: *64 + parent: *68 + source: *68 forks: type: integer master_branch: @@ -40381,7 +41024,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &448 + code_of_conduct: &452 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -40411,7 +41054,7 @@ paths: - key - name - html_url - security_and_analysis: *257 + security_and_analysis: *263 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -40495,7 +41138,7 @@ paths: - network_count - subscribers_count examples: - default: &319 + default: &321 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -41013,10 +41656,10 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - *17 - *19 - - &567 + - &570 name: targets description: | A comma-separated list of rule targets to filter by. @@ -41035,7 +41678,7 @@ paths: application/json: schema: type: array - items: &283 + items: &290 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -41070,7 +41713,7 @@ paths: source: type: string description: The name of the source - enforcement: &260 + enforcement: &266 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -41083,7 +41726,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &261 + items: &267 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -41154,7 +41797,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &258 + - &264 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -41178,7 +41821,7 @@ paths: match. items: type: string - - &262 + - &268 title: Organization ruleset conditions type: object description: |- @@ -41192,7 +41835,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *258 + - *264 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -41226,7 +41869,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *258 + - *264 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -41248,7 +41891,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *258 + - *264 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -41261,7 +41904,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &259 + items: &265 title: Repository ruleset property targeting definition type: object @@ -41294,7 +41937,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *259 + items: *265 required: - repository_property type: @@ -41302,12 +41945,12 @@ paths: - object rules: type: array - items: &568 + items: &571 title: Repository Rule type: object description: A repository rule. oneOf: - - &263 + - &269 title: creation description: Only allow users with bypass permission to create matching refs. @@ -41319,7 +41962,7 @@ paths: type: string enum: - creation - - &264 + - &270 title: update description: Only allow users with bypass permission to update matching refs. @@ -41340,7 +41983,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &265 + - &271 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -41352,7 +41995,7 @@ paths: type: string enum: - deletion - - &266 + - &272 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -41364,7 +42007,7 @@ paths: type: string enum: - required_linear_history - - &565 + - &569 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -41442,7 +42085,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &267 + - &273 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -41466,7 +42109,7 @@ paths: type: string required: - required_deployment_environments - - &268 + - &274 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -41478,7 +42121,7 @@ paths: type: string enum: - required_signatures - - &269 + - &275 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -41509,7 +42152,8 @@ paths: type: boolean description: Request Copilot code review for new pull requests automatically if the author has - access to Copilot code review. + access to Copilot code review and their premium + requests quota has not reached the limit. dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will @@ -41589,7 +42233,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &270 + - &276 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -41637,7 +42281,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &271 + - &277 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -41649,7 +42293,7 @@ paths: type: string enum: - non_fast_forward - - &272 + - &278 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -41685,7 +42329,7 @@ paths: required: - operator - pattern - - &273 + - &279 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -41721,7 +42365,7 @@ paths: required: - operator - pattern - - &274 + - &280 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -41757,7 +42401,7 @@ paths: required: - operator - pattern - - &275 + - &281 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -41793,7 +42437,7 @@ paths: required: - operator - pattern - - &276 + - &282 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -41829,7 +42473,7 @@ paths: required: - operator - pattern - - &277 + - &283 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -41854,7 +42498,7 @@ paths: type: string required: - restricted_file_paths - - &278 + - &284 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -41878,7 +42522,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &279 + - &285 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -41901,7 +42545,7 @@ paths: type: string required: - restricted_file_extensions - - &280 + - &286 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -41926,7 +42570,7 @@ paths: maximum: 100 required: - max_file_size - - &281 + - &287 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -41976,7 +42620,7 @@ paths: - repository_id required: - workflows - - &282 + - &288 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -42037,11 +42681,12 @@ paths: - tool required: - code_scanning_tools - - &566 + - &289 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code - review. + review and their premium requests quota has not reached + the limit. type: object required: - type @@ -42098,7 +42743,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -42114,7 +42759,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 requestBody: description: Request body required: true @@ -42135,26 +42780,20 @@ paths: - push - repository default: branch - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *262 + items: *267 + conditions: *268 rules: type: array description: An array of rules within the ruleset. - items: &285 + items: &292 title: Repository Rule type: object description: A repository rule. oneOf: - - *263 - - *264 - - *265 - - *266 - - *267 - - *268 - *269 - *270 - *271 @@ -42169,6 +42808,13 @@ paths: - *280 - *281 - *282 + - *283 + - *284 + - *285 + - *286 + - *287 + - *288 + - *289 required: - name - enforcement @@ -42206,9 +42852,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: &284 + default: &291 value: id: 21 name: super cool ruleset @@ -42248,7 +42894,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -42262,8 +42908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *61 - - &569 + - *65 + - &572 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 @@ -42278,7 +42924,7 @@ paths: in: query schema: type: string - - &570 + - &573 name: time_period description: |- The time period to filter by. @@ -42294,14 +42940,14 @@ paths: - week - month default: day - - &571 + - &574 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 + - &575 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -42321,7 +42967,7 @@ paths: description: Response content: application/json: - schema: &573 + schema: &576 title: Rule Suites description: Response type: array @@ -42377,7 +43023,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &574 + default: &577 value: - id: 21 actor_id: 12 @@ -42401,7 +43047,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42420,8 +43066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *61 - - &575 + - *65 + - &578 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -42437,7 +43083,7 @@ paths: description: Response content: application/json: - schema: &576 + schema: &579 title: Rule Suite description: Response type: object @@ -42544,7 +43190,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &577 + default: &580 value: id: 21 actor_id: 12 @@ -42579,7 +43225,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42605,7 +43251,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42617,11 +43263,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *284 + default: *291 '404': *6 - '500': *96 + '500': *102 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -42637,7 +43283,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42663,16 +43309,16 @@ paths: - tag - push - repository - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *262 + items: *267 + conditions: *268 rules: description: An array of rules within the ruleset. type: array - items: *285 + items: *292 examples: default: value: @@ -42707,11 +43353,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *284 + default: *291 '404': *6 - '500': *96 + '500': *102 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -42727,7 +43373,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42738,7 +43384,7 @@ paths: '204': description: Response '404': *6 - '500': *96 + '500': *102 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -42750,7 +43396,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *61 + - *65 - *17 - *19 - name: ruleset_id @@ -42766,7 +43412,7 @@ paths: application/json: schema: type: array - items: &286 + items: &293 title: Ruleset version type: object description: The historical version of a ruleset @@ -42790,7 +43436,7 @@ paths: type: string format: date-time examples: - default: &579 + default: &582 value: - version_id: 3 actor: @@ -42808,7 +43454,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42825,7 +43471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42843,9 +43489,9 @@ paths: description: Response content: application/json: - schema: &580 + schema: &583 allOf: - - *286 + - *293 - type: object required: - state @@ -42892,7 +43538,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42914,8 +43560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *61 - - &581 + - *65 + - &584 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -42926,7 +43572,7 @@ paths: enum: - open - resolved - - &582 + - &585 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -42936,7 +43582,7 @@ paths: required: false schema: type: string - - &583 + - &586 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -42945,7 +43591,26 @@ paths: required: false schema: type: string - - &584 + - &587 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &588 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. @@ -42957,10 +43622,10 @@ paths: - created - updated default: created - - *46 + - *50 - *19 - *17 - - &585 + - &589 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 @@ -42970,7 +43635,7 @@ paths: required: false schema: type: string - - &586 + - &590 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 @@ -42980,7 +43645,7 @@ paths: required: false schema: type: string - - &587 + - &591 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -42989,7 +43654,7 @@ paths: required: false schema: type: string - - &588 + - &592 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -42998,7 +43663,7 @@ paths: schema: type: boolean default: false - - &589 + - &593 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -43007,7 +43672,7 @@ paths: schema: type: boolean default: false - - &590 + - &594 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -43026,27 +43691,27 @@ paths: items: type: object properties: - number: *154 - created_at: *155 + number: *160 + created_at: *161 updated_at: anyOf: - type: 'null' - - *156 - url: *157 - html_url: *158 + - *162 + url: *163 + html_url: *164 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &591 + state: &595 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: &592 + resolution: &596 type: - string - 'null' @@ -43080,7 +43745,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *51 + repository: *55 push_protection_bypassed: type: - boolean @@ -43153,14 +43818,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &593 + - &597 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &595 + - &599 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -43217,7 +43882,7 @@ paths: - blob_url - commit_sha - commit_url - - &596 + - &600 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. @@ -43278,7 +43943,7 @@ paths: - page_url - commit_sha - commit_url - - &597 + - &601 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -43293,7 +43958,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &598 + - &602 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -43308,7 +43973,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &599 + - &603 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -43323,7 +43988,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &600 + - &604 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -43338,7 +44003,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &601 + - &605 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -43353,7 +44018,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &602 + - &606 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -43368,7 +44033,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &603 + - &607 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. @@ -43383,7 +44048,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &604 + - &608 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. @@ -43398,7 +44063,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &605 + - &609 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. @@ -43413,7 +44078,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &606 + - &610 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. @@ -43428,7 +44093,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &607 + - &611 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 @@ -43629,9 +44294,9 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43656,7 +44321,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *61 + - *65 responses: '200': description: Response @@ -43668,7 +44333,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &288 + pattern_config_version: &295 type: - string - 'null' @@ -43678,7 +44343,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &287 + items: &294 type: object properties: token_type: @@ -43747,7 +44412,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *287 + items: *294 examples: default: value: @@ -43796,7 +44461,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *61 + - *65 requestBody: required: true content: @@ -43804,7 +44469,7 @@ paths: schema: type: object properties: - pattern_config_version: *288 + pattern_config_version: *295 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -43830,7 +44495,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *288 + custom_pattern_version: *295 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -43866,7 +44531,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 "/orgs/{org}/security-advisories": get: @@ -43884,8 +44549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *61 - - *46 + - *65 + - *50 - name: sort description: The property to sort the results by. in: query @@ -43897,8 +44562,8 @@ paths: - updated - published default: created - - *38 - - *39 + - *43 + - *44 - 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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -43928,7 +44593,7 @@ paths: application/json: schema: type: array - items: &611 + items: &615 description: A repository security advisory. type: object properties: @@ -44136,7 +44801,7 @@ paths: required: - vector_string - score - cvss_severities: *48 + cvss_severities: *52 cwes: type: - array @@ -44172,7 +44837,7 @@ paths: login: type: string description: The username of the user credited. - type: *289 + type: *296 credits_detailed: type: - array @@ -44183,7 +44848,7 @@ paths: type: object properties: user: *4 - type: *289 + type: *296 state: type: string description: The state of the user's acceptance of the @@ -44209,13 +44874,13 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *172 + items: *178 private_fork: readOnly: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *51 + - *55 type: - 'null' required: @@ -44247,7 +44912,7 @@ paths: - private_fork additionalProperties: false examples: - default: &612 + default: &616 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44626,7 +45291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *61 + - *65 responses: '200': description: Response @@ -44634,9 +45299,9 @@ paths: application/json: schema: type: array - items: *223 + items: *229 examples: - default: *224 + default: *230 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44659,8 +45324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -44685,8 +45350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -44713,7 +45378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Immutable releases settings response @@ -44763,7 +45428,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -44821,7 +45486,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *61 + - *65 - *19 - *17 responses: @@ -44839,9 +45504,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44860,7 +45525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *61 + - *65 requestBody: required: true content: @@ -44909,8 +45574,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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: Response @@ -44932,8 +45597,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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: Response @@ -44956,7 +45621,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -44974,7 +45639,7 @@ paths: type: integer network_configurations: type: array - items: &290 + items: &297 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -45038,7 +45703,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45057,7 +45722,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: - - *61 + - *65 requestBody: required: true content: @@ -45099,9 +45764,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *297 examples: - default: &291 + default: &298 value: id: 123456789ABCDEF name: My network configuration @@ -45129,8 +45794,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: - - *61 - - &292 + - *65 + - &299 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -45142,11 +45807,11 @@ paths: description: Response content: application/json: - schema: *290 + schema: *297 examples: - default: *291 + default: *298 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45165,8 +45830,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: - - *61 - - *292 + - *65 + - *299 requestBody: required: true content: @@ -45205,9 +45870,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *297 examples: - default: *291 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45226,8 +45891,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: - - *61 - - *292 + - *65 + - *299 responses: '204': description: Response @@ -45250,7 +45915,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: - - *61 + - *65 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -45309,7 +45974,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45339,8 +46004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *61 - - *62 + - *65 + - *66 - 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`). @@ -45372,13 +46037,13 @@ paths: application/json: schema: type: array - items: *293 + items: *300 examples: - default: *294 - '500': *96 + default: *301 + '500': *102 '403': *27 '404': *6 - '422': *295 + '422': *302 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45396,7 +46061,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *61 + - *65 - *17 - *19 responses: @@ -45406,11 +46071,11 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -45430,7 +46095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *61 + - *65 requestBody: required: true content: @@ -45502,7 +46167,7 @@ paths: description: Response content: application/json: - schema: &296 + schema: &303 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -45576,7 +46241,7 @@ paths: parent: anyOf: - type: 'null' - - *223 + - *229 members_count: type: integer examples: @@ -45901,7 +46566,7 @@ paths: - repos_count - organization examples: - default: &297 + default: &304 value: id: 1 node_id: MDQ6VGVhbTE= @@ -45971,16 +46636,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *61 - - *62 + - *65 + - *66 responses: '200': description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -46001,8 +46666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *61 - - *62 + - *65 + - *66 requestBody: required: false content: @@ -46065,16 +46730,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '201': description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 '422': *15 '403': *27 @@ -46099,8 +46764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -46126,9 +46791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *61 - - *62 - - *46 + - *65 + - *66 + - *50 - *17 - *19 - name: pinned @@ -46144,7 +46809,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -46235,7 +46900,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *66 + reactions: *70 required: - author - body @@ -46255,7 +46920,7 @@ paths: - updated_at - url examples: - default: &629 + default: &633 value: - author: login: octocat @@ -46305,7 +46970,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46329,8 +46994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *61 - - *62 + - *65 + - *66 requestBody: required: true content: @@ -46364,9 +47029,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &299 + default: &306 value: author: login: octocat @@ -46438,9 +47103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *61 - - *62 - - &300 + - *65 + - *66 + - &307 name: discussion_number description: The number that identifies the discussion. in: path @@ -46452,9 +47117,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46476,9 +47141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 requestBody: required: false content: @@ -46501,9 +47166,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &630 + default: &634 value: author: login: octocat @@ -46573,9 +47238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 responses: '204': description: Response @@ -46601,10 +47266,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *61 - - *62 - - *300 - - *46 + - *65 + - *66 + - *307 + - *50 - *17 - *19 responses: @@ -46614,7 +47279,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -46679,7 +47344,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *66 + reactions: *70 required: - author - body @@ -46694,7 +47359,7 @@ paths: - updated_at - url examples: - default: &631 + default: &635 value: - author: login: octocat @@ -46738,7 +47403,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46762,9 +47427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 requestBody: required: true content: @@ -46786,9 +47451,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: &302 + default: &309 value: author: login: octocat @@ -46854,10 +47519,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *61 - - *62 - - *300 - - &303 + - *65 + - *66 + - *307 + - &310 name: comment_number description: The number that identifies the comment. in: path @@ -46869,9 +47534,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46893,10 +47558,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 requestBody: required: true content: @@ -46918,9 +47583,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: &632 + default: &636 value: author: login: octocat @@ -46984,10 +47649,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 responses: '204': description: Response @@ -47013,10 +47678,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 - 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. @@ -47042,7 +47707,7 @@ paths: application/json: schema: type: array - items: &304 + items: &311 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -47086,7 +47751,7 @@ paths: - content - created_at examples: - default: &306 + default: &313 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -47112,7 +47777,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47136,10 +47801,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 requestBody: required: true content: @@ -47172,9 +47837,9 @@ paths: team discussion comment content: application/json: - schema: *304 + schema: *311 examples: - default: &305 + default: &312 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -47203,9 +47868,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47228,11 +47893,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *61 - - *62 - - *300 - - *303 - - &307 + - *65 + - *66 + - *307 + - *310 + - &314 name: reaction_id description: The unique identifier of the reaction. in: path @@ -47264,9 +47929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 - 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. @@ -47292,11 +47957,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47320,9 +47985,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 requestBody: required: true content: @@ -47354,16 +48019,16 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47386,10 +48051,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *61 - - *62 - - *300 + - *65 + - *66 - *307 + - *314 responses: '204': description: Response @@ -47413,8 +48078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *61 - - *62 + - *65 + - *66 - *17 - *19 responses: @@ -47424,11 +48089,11 @@ paths: application/json: schema: type: array - items: *205 + items: *211 examples: - default: *206 + default: *212 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47448,8 +48113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *61 - - *62 + - *65 + - *66 - name: role description: Filters members returned by their role in the team. in: query @@ -47472,9 +48137,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47502,15 +48167,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: + - *65 + - *66 - *61 - - *62 - - *57 responses: '200': description: Response content: application/json: - schema: &308 + schema: &315 title: Team Membership description: Team Membership type: object @@ -47538,7 +48203,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &633 + response-if-user-is-a-team-maintainer: &637 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47574,9 +48239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: + - *65 + - *66 - *61 - - *62 - - *57 requestBody: required: false content: @@ -47601,9 +48266,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - response-if-users-membership-with-team-is-now-pending: &634 + response-if-users-membership-with-team-is-now-pending: &638 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47638,9 +48303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: + - *65 + - *66 - *61 - - *62 - - *57 responses: '204': description: Response @@ -47651,324 +48316,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - *61 - - *62 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &309 - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: - - string - - 'null' - number: - type: integer - state: - type: string - creator: *4 - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only - present when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present - when owner is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - examples: - default: &635 - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - headers: - Link: *52 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *61 - - *62 - - &310 - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *309 - examples: - default: &636 - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *61 - - *62 - - *310 - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - *61 - - *62 - - *310 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -47984,8 +48331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *61 - - *62 + - *65 + - *66 - *17 - *19 responses: @@ -47995,11 +48342,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48026,16 +48373,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *61 - - *62 - - *311 - - *312 + - *65 + - *66 + - *316 + - *317 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &637 + schema: &639 title: Team Repository description: A team's access to a repository. type: object @@ -48061,7 +48408,7 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 forks: type: integer permissions: @@ -48676,10 +49023,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *61 - - *62 - - *311 - - *312 + - *65 + - *66 + - *316 + - *317 requestBody: required: false content: @@ -48724,10 +49071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *61 - - *62 - - *311 - - *312 + - *65 + - *66 + - *316 + - *317 responses: '204': description: Response @@ -48751,8 +49098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *61 - - *62 + - *65 + - *66 - *17 - *19 responses: @@ -48762,9 +49109,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - response-if-child-teams-exist: &638 + response-if-child-teams-exist: &640 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -48792,7 +49139,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48817,7 +49164,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *61 + - *65 - name: security_product in: path description: The security feature to enable or disable. @@ -48877,464 +49224,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - &313 - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &314 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - examples: - - https://api.github.com/projects/120 - cards_url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - type: integer - examples: - - 42 - node_id: - type: string - examples: - - MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - created_at: - type: string - format: date-time - examples: - - '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - examples: - - '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &315 - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': *35 - '403': *27 - '404': *6 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *313 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *314 - examples: - default: *315 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - *313 - responses: - '204': - description: Response - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - *313 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - type: string - pattern: "^(?:first|last|after:\\d+)$" - examples: - - last - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *35 - '403': *27 - '422': *7 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *310 - - 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 - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *56 - headers: - Link: *52 - '404': *6 - '422': *15 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *310 - - *57 - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - type: string - examples: - - write - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *310 - - *57 - responses: - '204': - description: Response - '304': *35 - '404': *6 - '403': *27 - '422': *15 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *310 - - *57 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - anyOf: - - type: 'null' - - *4 - required: - - permission - - user - examples: - default: - value: - permission: admin - user: - 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 - '404': *6 - '422': *15 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -49376,7 +49265,7 @@ paths: resources: type: object properties: - core: &316 + core: &318 title: Rate Limit type: object properties: @@ -49393,21 +49282,21 @@ paths: - remaining - reset - used - 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 + graphql: *318 + search: *318 + code_search: *318 + source_import: *318 + integration_manifest: *318 + code_scanning_upload: *318 + actions_runner_registration: *318 + scim: *318 + dependency_snapshots: *318 + dependency_sbom: *318 + code_scanning_autofix: *318 required: - core - search - rate: *316 + rate: *318 required: - rate - resources @@ -49512,14 +49401,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *317 + schema: *319 examples: default-response: summary: Default response @@ -50020,7 +49909,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *318 + '301': *320 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50038,8 +49927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -50287,10 +50176,10 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 - '307': &320 + default: *321 + '307': &322 description: Temporary Redirect content: application/json: @@ -50319,8 +50208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -50342,9 +50231,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *320 + '307': *322 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50366,11 +50255,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - - &351 + - &355 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50393,7 +50282,7 @@ paths: type: integer artifacts: type: array - items: &321 + items: &323 title: Artifact description: An artifact type: object @@ -50488,7 +50377,7 @@ paths: - expires_at - updated_at examples: - default: &352 + default: &356 value: total_count: 2 artifacts: @@ -50527,7 +50416,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50549,9 +50438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *311 - - *312 - - &322 + - *316 + - *317 + - &324 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50563,7 +50452,7 @@ paths: description: Response content: application/json: - schema: *321 + schema: *323 examples: default: value: @@ -50601,9 +50490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *311 - - *312 - - *322 + - *316 + - *317 + - *324 responses: '204': description: Response @@ -50627,9 +50516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *311 - - *312 - - *322 + - *316 + - *317 + - *324 - name: archive_format in: path required: true @@ -50643,7 +50532,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': &502 + '410': &506 description: Gone content: application/json: @@ -50653,6 +50542,158 @@ paths: enabledForGitHubApps: true category: actions subcategory: artifacts + "/repos/{owner}/{repo}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - *316 + - *317 + responses: + '200': + description: Response + content: + application/json: + schema: &325 + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this + repository. + type: integer + examples: + - 14 + examples: + default: *40 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - *316 + - *317 + requestBody: + required: true + content: + application/json: + schema: *325 + examples: + selected_actions: *40 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/repos/{owner}/{repo}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - *316 + - *317 + responses: + '200': + description: Response + content: + application/json: + schema: &326 + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, + in gigabytes. + type: integer + examples: + - 10 + examples: + default: *42 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - *316 + - *317 + requestBody: + required: true + content: + application/json: + schema: *326 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository @@ -50670,14 +50711,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *323 + schema: *327 examples: default: value: @@ -50703,11 +50744,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - - &324 + - &328 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 @@ -50735,13 +50776,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *46 + - *50 responses: '200': description: Response content: application/json: - schema: &325 + schema: &329 title: Repository actions caches description: Repository actions caches type: object @@ -50791,7 +50832,7 @@ paths: - total_count - actions_caches examples: - default: &326 + default: &330 value: total_count: 1 actions_caches: @@ -50803,7 +50844,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50823,23 +50864,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: - - *311 - - *312 + - *316 + - *317 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *324 + - *328 responses: '200': description: Response content: application/json: - schema: *325 + schema: *329 examples: - default: *326 + default: *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50859,8 +50900,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: - - *311 - - *312 + - *316 + - *317 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -50891,9 +50932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *311 - - *312 - - &327 + - *316 + - *317 + - &331 name: job_id description: The unique identifier of the job. in: path @@ -50905,7 +50946,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &359 title: Job description: Information of a job execution in a workflow run type: object @@ -51252,9 +51293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *311 - - *312 - - *327 + - *316 + - *317 + - *331 responses: '302': description: Response @@ -51282,9 +51323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *311 - - *312 - - *327 + - *316 + - *317 + - *331 requestBody: required: false content: @@ -51306,7 +51347,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -51330,8 +51371,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Status response @@ -51381,8 +51422,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -51416,7 +51457,7 @@ paths: description: Empty response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -51445,8 +51486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -51464,7 +51505,7 @@ paths: type: integer secrets: type: array - items: &357 + items: &361 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51485,7 +51526,7 @@ paths: - created_at - updated_at examples: - default: &358 + default: &362 value: total_count: 2 secrets: @@ -51496,7 +51537,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51518,9 +51559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *311 - - *312 - - *328 + - *316 + - *317 + - *332 - *19 responses: '200': @@ -51537,7 +51578,7 @@ paths: type: integer variables: type: array - items: &361 + items: &365 title: Actions Variable type: object properties: @@ -51571,7 +51612,7 @@ paths: - created_at - updated_at examples: - default: &362 + default: &366 value: total_count: 2 variables: @@ -51584,7 +51625,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51604,8 +51645,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -51614,12 +51655,12 @@ paths: schema: type: object properties: - enabled: &330 + enabled: &334 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *121 - selected_actions_url: *329 - sha_pinning_required: *122 + allowed_actions: *127 + selected_actions_url: *333 + sha_pinning_required: *128 required: - enabled examples: @@ -51647,8 +51688,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -51659,9 +51700,9 @@ paths: schema: type: object properties: - enabled: *330 - allowed_actions: *121 - sha_pinning_required: *122 + enabled: *334 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled examples: @@ -51691,14 +51732,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: &331 + schema: &335 type: object properties: access_level: @@ -51715,7 +51756,7 @@ paths: required: - access_level examples: - default: &332 + default: &336 value: access_level: organization x-github: @@ -51739,15 +51780,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: application/json: - schema: *331 + schema: *335 examples: - default: *332 + default: *336 responses: '204': description: Response @@ -51771,14 +51812,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *333 + schema: *337 examples: default: value: @@ -51802,8 +51843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Empty response for successful settings update @@ -51813,7 +51854,7 @@ paths: required: true content: application/json: - schema: *334 + schema: *338 examples: default: summary: Set retention days @@ -51837,16 +51878,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *123 + schema: *129 examples: - default: *335 + default: *339 '404': *6 x-github: enabledForGitHubApps: true @@ -51865,8 +51906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -51876,7 +51917,7 @@ paths: required: true content: application/json: - schema: *123 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -51900,16 +51941,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: - default: *124 + default: *130 '403': *27 '404': *6 x-github: @@ -51929,15 +51970,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: application/json: - schema: *337 + schema: *341 examples: - default: *124 + default: *130 responses: '204': description: Empty response for successful settings update @@ -51961,16 +52002,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *126 + schema: *132 examples: - default: *127 + default: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51989,8 +52030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -51998,9 +52039,9 @@ paths: required: false content: application/json: - schema: *126 + schema: *132 examples: - selected_actions: *127 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52022,16 +52063,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *338 + schema: *342 examples: - default: *131 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52052,8 +52093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Success response @@ -52064,9 +52105,9 @@ paths: required: true content: application/json: - schema: *339 + schema: *343 examples: - default: *131 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52093,8 +52134,8 @@ paths: in: query schema: type: string - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -52112,11 +52153,11 @@ paths: type: integer runners: type: array - items: *138 + items: *144 examples: - default: *139 + default: *145 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52138,8 +52179,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -52147,9 +52188,9 @@ paths: application/json: schema: type: array - items: *340 + items: *344 examples: - default: *341 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52171,8 +52212,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -52215,10 +52256,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *342 + '201': *346 '404': *6 '422': *7 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52246,16 +52287,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '201': description: Response content: application/json: - schema: *140 + schema: *146 examples: - default: *343 + default: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52283,16 +52324,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '201': description: Response content: application/json: - schema: *140 + schema: *146 examples: - default: *344 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52314,17 +52355,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: '200': description: Response content: application/json: - schema: *138 + schema: *144 examples: - default: *345 + default: *349 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52345,9 +52386,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: '204': description: Response @@ -52373,11 +52414,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: - '200': *142 + '200': *148 '404': *6 x-github: githubCloudOnly: false @@ -52399,9 +52440,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 requestBody: required: true content: @@ -52425,7 +52466,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -52449,9 +52490,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 requestBody: required: true content: @@ -52476,7 +52517,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -52500,11 +52541,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: - '200': *346 + '200': *350 '404': *6 x-github: githubCloudOnly: false @@ -52531,12 +52572,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: - - *311 - - *312 - - *137 - - *347 + - *316 + - *317 + - *143 + - *351 responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -52562,9 +52603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *311 - - *312 - - &365 + - *316 + - *317 + - &369 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. @@ -52572,7 +52613,7 @@ paths: required: false schema: type: string - - &366 + - &370 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52580,7 +52621,7 @@ paths: required: false schema: type: string - - &367 + - &371 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52589,7 +52630,7 @@ paths: required: false schema: type: string - - &368 + - &372 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 @@ -52616,7 +52657,7 @@ paths: - pending - *17 - *19 - - &369 + - &373 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)." @@ -52625,7 +52666,7 @@ paths: schema: type: string format: date-time - - &348 + - &352 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52634,13 +52675,13 @@ paths: schema: type: boolean default: false - - &370 + - &374 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &371 + - &375 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52663,7 +52704,7 @@ paths: type: integer workflow_runs: type: array - items: &349 + items: &353 title: Workflow Run description: An invocation of a workflow type: object @@ -52780,7 +52821,7 @@ paths: type: - array - 'null' - items: &390 + items: &394 title: Pull Request Minimal type: object properties: @@ -52907,7 +52948,7 @@ paths: head_commit: anyOf: - type: 'null' - - &394 + - &398 title: Simple Commit description: A commit. type: object @@ -52981,8 +53022,8 @@ paths: - timestamp - author - committer - repository: *136 - head_repository: *136 + repository: *142 + head_repository: *142 head_repository_id: type: integer examples: @@ -53022,7 +53063,7 @@ paths: - workflow_url - pull_requests examples: - default: &372 + default: &376 value: total_count: 1 workflow_runs: @@ -53236,7 +53277,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53258,24 +53299,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *311 - - *312 - - &350 + - *316 + - *317 + - &354 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *348 + - *352 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: &353 + default: &357 value: id: 30433642 name: Build @@ -53516,9 +53557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '204': description: Response @@ -53541,9 +53582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '200': description: Response @@ -53671,15 +53712,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: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -53706,12 +53747,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 - *17 - *19 - - *351 + - *355 responses: '200': description: Response @@ -53727,11 +53768,11 @@ paths: type: integer artifacts: type: array - items: *321 + items: *323 examples: - default: *352 + default: *356 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53753,25 +53794,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *311 - - *312 - - *350 - - &354 + - *316 + - *317 + - *354 + - &358 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *348 + - *352 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: *353 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53794,10 +53835,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *311 - - *312 - - *350 + - *316 + - *317 - *354 + - *358 - *17 - *19 responses: @@ -53815,9 +53856,9 @@ paths: type: integer jobs: type: array - items: *355 + items: *359 examples: - default: &356 + default: &360 value: total_count: 1 jobs: @@ -53906,7 +53947,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -53930,10 +53971,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *311 - - *312 - - *350 + - *316 + - *317 - *354 + - *358 responses: '302': description: Response @@ -53961,19 +54002,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '202': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53996,9 +54037,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: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: true content: @@ -54065,19 +54106,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '202': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54100,9 +54141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 - 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 @@ -54132,11 +54173,11 @@ paths: type: integer jobs: type: array - items: *355 + items: *359 examples: - default: *356 + default: *360 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54159,9 +54200,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '302': description: Response @@ -54188,14 +54229,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '204': description: Response '403': *27 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54217,9 +54258,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '200': description: Response @@ -54288,7 +54329,7 @@ paths: items: type: object properties: - type: &468 + type: &472 type: string description: The type of reviewer. enum: @@ -54299,7 +54340,7 @@ paths: reviewer: anyOf: - *4 - - *172 + - *178 required: - environment - wait_timer @@ -54374,9 +54415,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: true content: @@ -54426,7 +54467,7 @@ paths: application/json: schema: type: array - items: &463 + items: &467 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54538,7 +54579,7 @@ paths: - created_at - updated_at examples: - default: &464 + default: &468 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54594,9 +54635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: false content: @@ -54618,7 +54659,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -54641,9 +54682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: false content: @@ -54665,7 +54706,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -54697,9 +54738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '200': description: Response @@ -54836,8 +54877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -54855,11 +54896,11 @@ paths: type: integer secrets: type: array - items: *357 + items: *361 examples: - default: *358 + default: *362 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54882,16 +54923,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54913,17 +54954,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '200': description: Response content: application/json: - schema: *357 + schema: *361 examples: - default: &481 + default: &485 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54949,9 +54990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 requestBody: required: true content: @@ -54982,7 +55023,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -55008,9 +55049,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '204': description: Response @@ -55035,9 +55076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *311 - - *312 - - *328 + - *316 + - *317 + - *332 - *19 responses: '200': @@ -55054,11 +55095,11 @@ paths: type: integer variables: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55079,8 +55120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -55107,7 +55148,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -55132,17 +55173,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *311 - - *312 - - *147 + - *316 + - *317 + - *153 responses: '200': description: Response content: application/json: - schema: *361 + schema: *365 examples: - default: &482 + default: &486 value: name: USERNAME value: octocat @@ -55168,9 +55209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *311 - - *312 - - *147 + - *316 + - *317 + - *153 requestBody: required: true content: @@ -55212,9 +55253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *311 - - *312 - - *147 + - *316 + - *317 + - *153 responses: '204': description: Response @@ -55239,8 +55280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -55258,7 +55299,7 @@ paths: type: integer workflows: type: array - items: &363 + items: &367 title: Workflow description: A GitHub Actions workflow type: object @@ -55353,7 +55394,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55376,9 +55417,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *311 - - *312 - - &364 + - *316 + - *317 + - &368 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55393,7 +55434,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -55426,9 +55467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '204': description: Response @@ -55453,9 +55494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '204': description: Response @@ -55506,9 +55547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '204': description: Response @@ -55535,19 +55576,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *311 - - *312 - - *364 - - *365 - - *366 - - *367 + - *316 + - *317 - *368 - - *17 - - *19 - *369 - - *348 - *370 - *371 + - *372 + - *17 + - *19 + - *373 + - *352 + - *374 + - *375 responses: '200': description: Response @@ -55563,11 +55604,11 @@ paths: type: integer workflow_runs: type: array - items: *349 + items: *353 examples: - default: *372 + default: *376 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55597,9 +55638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '200': description: Response @@ -55660,12 +55701,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *311 - - *312 - - *46 + - *316 + - *317 + - *50 - *17 - - *38 - - *39 + - *43 + - *44 - name: ref description: |- The Git reference for the activities you want to list. @@ -55810,7 +55851,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '422': *7 x-github: githubCloudOnly: false @@ -55829,8 +55870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -55842,9 +55883,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -55867,8 +55908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *311 - - *312 + - *316 + - *317 - name: assignee in: path required: true @@ -55904,8 +55945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -56017,11 +56058,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *311 - - *312 + - *316 + - *317 - *17 - - *38 - - *39 + - *43 + - *44 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -56075,7 +56116,7 @@ paths: initiator: type: string examples: - default: *373 + default: *377 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56095,8 +56136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -56104,7 +56145,7 @@ paths: application/json: schema: type: array - items: &374 + items: &378 title: Autolink reference description: An autolink reference. type: object @@ -56163,8 +56204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -56203,9 +56244,9 @@ paths: description: response content: application/json: - schema: *374 + schema: *378 examples: - default: &375 + default: &379 value: id: 1 key_prefix: TICKET- @@ -56236,9 +56277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *311 - - *312 - - &376 + - *316 + - *317 + - &380 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56250,9 +56291,9 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 '404': *6 x-github: githubCloudOnly: false @@ -56272,9 +56313,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *311 - - *312 - - *376 + - *316 + - *317 + - *380 responses: '204': description: Response @@ -56298,8 +56339,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response if Dependabot is enabled @@ -56349,8 +56390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -56371,8 +56412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -56392,8 +56433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *311 - - *312 + - *316 + - *317 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56431,7 +56472,7 @@ paths: - url protected: type: boolean - protection: &378 + protection: &382 title: Branch Protection description: Branch Protection type: object @@ -56474,7 +56515,7 @@ paths: required: - contexts - checks - enforce_admins: &381 + enforce_admins: &385 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56491,7 +56532,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &383 + required_pull_request_reviews: &387 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56513,7 +56554,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *172 + items: *178 apps: description: The list of apps with review dismissal access. @@ -56545,7 +56586,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *172 + items: *178 apps: description: The list of apps allowed to bypass pull request requirements. @@ -56575,7 +56616,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &380 + restrictions: &384 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56638,7 +56679,7 @@ paths: type: string teams: type: array - items: *172 + items: *178 apps: type: array items: @@ -56850,7 +56891,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -56868,9 +56909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *311 - - *312 - - &379 + - *316 + - *317 + - &383 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). @@ -56884,14 +56925,14 @@ paths: description: Response content: application/json: - schema: &389 + schema: &393 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &439 + commit: &443 title: Commit description: Commit type: object @@ -56930,7 +56971,7 @@ paths: author: anyOf: - type: 'null' - - &377 + - &381 title: Git User description: Metaproperties for Git author/committer information. @@ -56946,12 +56987,13 @@ paths: - '"chris@ozmm.org"' date: type: string + format: date-time examples: - '"2007-10-29T02:42:39.000-07:00"' committer: anyOf: - type: 'null' - - *377 + - *381 message: type: string examples: @@ -56975,7 +57017,7 @@ paths: required: - sha - url - verification: &488 + verification: &492 title: Verification type: object properties: @@ -57011,14 +57053,14 @@ paths: author: oneOf: - *4 - - *145 + - *151 type: - 'null' - object committer: oneOf: - *4 - - *145 + - *151 type: - 'null' - object @@ -57055,7 +57097,7 @@ paths: type: integer files: type: array - items: &450 + items: &454 title: Diff Entry description: Diff Entry type: object @@ -57151,7 +57193,7 @@ paths: - self protected: type: boolean - protection: *378 + protection: *382 protection_url: type: string format: uri @@ -57260,7 +57302,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *318 + '301': *320 '404': *6 x-github: githubCloudOnly: false @@ -57282,15 +57324,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *378 + schema: *382 examples: default: value: @@ -57484,9 +57526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -57746,7 +57788,7 @@ paths: url: type: string format: uri - required_status_checks: &386 + required_status_checks: &390 title: Status Check Policy description: Status Check Policy type: object @@ -57827,7 +57869,7 @@ paths: items: *4 teams: type: array - items: *172 + items: *178 apps: type: array items: *5 @@ -57845,7 +57887,7 @@ paths: items: *4 teams: type: array - items: *172 + items: *178 apps: type: array items: *5 @@ -57905,7 +57947,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *380 + restrictions: *384 required_conversation_resolution: type: object properties: @@ -58017,9 +58059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58044,17 +58086,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: &382 + default: &386 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58076,17 +58118,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *382 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58105,9 +58147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58132,17 +58174,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *383 + schema: *387 examples: - default: &384 + default: &388 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -58238,9 +58280,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58338,9 +58380,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *387 examples: - default: *384 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -58361,9 +58403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58390,17 +58432,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: &385 + default: &389 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58423,17 +58465,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *385 + default: *389 '404': *6 x-github: githubCloudOnly: false @@ -58453,9 +58495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58480,17 +58522,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *386 + schema: *390 examples: - default: &387 + default: &391 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58516,9 +58558,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58570,9 +58612,9 @@ paths: description: Response content: application/json: - schema: *386 + schema: *390 examples: - default: *387 + default: *391 '404': *6 '422': *15 x-github: @@ -58594,9 +58636,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58620,9 +58662,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -58656,9 +58698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58725,9 +58767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58791,9 +58833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: content: application/json: @@ -58859,15 +58901,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *380 + schema: *384 examples: default: value: @@ -58958,9 +59000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58983,9 +59025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -58995,7 +59037,7 @@ paths: type: array items: *5 examples: - default: &388 + default: &392 value: - id: 1 slug: octoapp @@ -59052,9 +59094,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59088,7 +59130,7 @@ paths: type: array items: *5 examples: - default: *388 + default: *392 '422': *15 x-github: githubCloudOnly: false @@ -59109,9 +59151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59145,7 +59187,7 @@ paths: type: array items: *5 examples: - default: *388 + default: *392 '422': *15 x-github: githubCloudOnly: false @@ -59166,9 +59208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59202,7 +59244,7 @@ paths: type: array items: *5 examples: - default: *388 + default: *392 '422': *15 x-github: githubCloudOnly: false @@ -59224,9 +59266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -59234,9 +59276,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '404': *6 x-github: githubCloudOnly: false @@ -59256,9 +59298,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -59294,9 +59336,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '422': *15 x-github: githubCloudOnly: false @@ -59317,9 +59359,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -59355,9 +59397,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '422': *15 x-github: githubCloudOnly: false @@ -59378,9 +59420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: content: application/json: @@ -59415,9 +59457,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '422': *15 x-github: githubCloudOnly: false @@ -59439,9 +59481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -59451,7 +59493,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '404': *6 x-github: githubCloudOnly: false @@ -59475,9 +59517,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59510,7 +59552,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '422': *15 x-github: githubCloudOnly: false @@ -59535,9 +59577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59570,7 +59612,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '422': *15 x-github: githubCloudOnly: false @@ -59595,9 +59637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59630,7 +59672,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '422': *15 x-github: githubCloudOnly: false @@ -59657,9 +59699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59681,7 +59723,7 @@ paths: description: Response content: application/json: - schema: *389 + schema: *393 examples: default: value: @@ -59797,8 +59839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -60077,7 +60119,7 @@ paths: description: Response content: application/json: - schema: &391 + schema: &395 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60212,8 +60254,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *390 - deployment: &689 + items: *394 + deployment: &700 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60500,9 +60542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *311 - - *312 - - &392 + - *316 + - *317 + - &396 name: check_run_id description: The unique identifier of the check run. in: path @@ -60514,9 +60556,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *395 examples: - default: &393 + default: &397 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60616,9 +60658,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *311 - - *312 - - *392 + - *316 + - *317 + - *396 requestBody: required: true content: @@ -60858,9 +60900,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *395 examples: - default: *393 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60880,9 +60922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *311 - - *312 - - *392 + - *316 + - *317 + - *396 - *17 - *19 responses: @@ -60972,7 +61014,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60992,15 +61034,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *311 - - *312 - - *392 + - *316 + - *317 + - *396 responses: '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -61038,8 +61080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -61061,7 +61103,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &395 + schema: &399 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61143,12 +61185,12 @@ paths: type: - array - 'null' - items: *390 + items: *394 app: anyOf: - type: 'null' - *5 - repository: *136 + repository: *142 created_at: type: - string @@ -61159,7 +61201,7 @@ paths: - string - 'null' format: date-time - head_commit: *394 + head_commit: *398 latest_check_runs_count: type: integer check_runs_url: @@ -61187,7 +61229,7 @@ paths: - check_runs_url - pull_requests examples: - default: &396 + default: &400 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61478,9 +61520,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *395 + schema: *399 examples: - default: *396 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61499,8 +61541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -61561,7 +61603,7 @@ paths: required: - app_id - setting - repository: *136 + repository: *142 examples: default: value: @@ -61809,9 +61851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *311 - - *312 - - &397 + - *316 + - *317 + - &401 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61823,9 +61865,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *399 examples: - default: *396 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61848,17 +61890,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *311 - - *312 - - *397 - - &445 + - *316 + - *317 + - *401 + - &449 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &446 + - &450 name: status description: Returns check runs with the specified `status`. in: query @@ -61897,9 +61939,9 @@ paths: type: integer check_runs: type: array - items: *391 + items: *395 examples: - default: &447 + default: &451 value: total_count: 1 check_runs: @@ -61981,7 +62023,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62001,15 +62043,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *311 - - *312 - - *397 + - *316 + - *317 + - *401 responses: '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -62036,30 +62078,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *311 - - *312 - - *398 - - *399 + - *316 + - *317 + - *402 + - *403 - *19 - *17 - - &416 + - &420 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: *400 - - &417 + schema: *404 + - &421 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *46 - - *38 - - *39 + - *50 + - *43 + - *44 - name: sort description: The property by which to sort the results. in: query @@ -62075,13 +62117,13 @@ paths: be returned. in: query required: false - schema: *401 + schema: *405 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *402 + schema: *406 responses: '200': description: Response @@ -62092,24 +62134,24 @@ paths: items: type: object properties: - number: *154 - created_at: *155 - updated_at: *156 - url: *157 - html_url: *158 - instances_url: *403 - state: *163 - fixed_at: *159 + number: *160 + created_at: *161 + updated_at: *162 + url: *163 + html_url: *164 + instances_url: *407 + state: *169 + fixed_at: *165 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *160 - dismissed_reason: *404 - dismissed_comment: *405 - rule: *406 - tool: *407 - most_recent_instance: *408 + dismissed_at: *166 + dismissed_reason: *408 + dismissed_comment: *409 + rule: *410 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: anyOf: - type: 'null' @@ -62232,14 +62274,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &409 + '403': &413 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62259,9 +62301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *311 - - *312 - - &410 + - *316 + - *317 + - &414 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -62269,30 +62311,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *154 + schema: *160 responses: '200': description: Response content: application/json: - schema: &411 + schema: &415 type: object properties: - number: *154 - created_at: *155 - updated_at: *156 - url: *157 - html_url: *158 - instances_url: *403 - state: *163 - fixed_at: *159 + number: *160 + created_at: *161 + updated_at: *162 + url: *163 + html_url: *164 + instances_url: *407 + state: *169 + fixed_at: *165 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *160 - dismissed_reason: *404 - dismissed_comment: *405 + dismissed_at: *166 + dismissed_reason: *408 + dismissed_comment: *409 rule: type: object properties: @@ -62354,8 +62396,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *407 - most_recent_instance: *408 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: anyOf: - type: 'null' @@ -62451,9 +62493,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62471,9 +62513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 requestBody: required: true content: @@ -62488,8 +62530,8 @@ paths: enum: - open - dismissed - dismissed_reason: *404 - dismissed_comment: *405 + dismissed_reason: *408 + dismissed_comment: *409 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62508,7 +62550,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *415 examples: default: value: @@ -62584,14 +62626,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &415 + '403': &419 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': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62611,15 +62653,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: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 responses: '200': description: Response content: application/json: - schema: &412 + schema: &416 type: object properties: status: @@ -62646,13 +62688,13 @@ paths: - description - started_at examples: - default: &413 + default: &417 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &414 + '400': &418 description: Bad Request content: application/json: @@ -62663,9 +62705,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': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62688,29 +62730,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: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 responses: '200': description: OK content: application/json: - schema: *412 + schema: *416 examples: - default: *413 + default: *417 '202': description: Accepted content: application/json: - schema: *412 + schema: *416 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *414 + '400': *418 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62720,7 +62762,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62742,9 +62784,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: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 requestBody: required: false content: @@ -62790,12 +62832,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *414 - '403': *415 + '400': *418 + '403': *419 '404': *6 '422': description: Unprocessable Entity - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62815,13 +62857,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 - *19 - *17 - - *416 - - *417 + - *420 + - *421 responses: '200': description: Response @@ -62829,7 +62871,7 @@ paths: application/json: schema: type: array - items: *408 + items: *412 examples: default: value: @@ -62868,9 +62910,9 @@ paths: end_column: 50 classifications: - source - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62902,30 +62944,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *311 - - *312 - - *398 - - *399 + - *316 + - *317 + - *402 + - *403 - *19 - *17 - - *417 + - *421 - 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: *400 + schema: *404 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &420 + schema: &424 type: string description: An identifier for the upload. examples: - 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *46 + - *50 - name: sort description: The property by which to sort the results. in: query @@ -62942,23 +62984,23 @@ paths: application/json: schema: type: array - items: &421 + items: &425 type: object properties: - ref: *400 - commit_sha: &429 + ref: *404 + commit_sha: &433 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: *418 + analysis_key: *422 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *419 + category: *423 error: type: string examples: @@ -62983,8 +63025,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *420 - tool: *407 + sarif_id: *424 + tool: *411 deletable: type: boolean warning: @@ -63046,9 +63088,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63082,8 +63124,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: - - *311 - - *312 + - *316 + - *317 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63096,7 +63138,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *425 examples: response: summary: application/json response @@ -63150,14 +63192,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *409 + '403': *413 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63237,8 +63279,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: - - *311 - - *312 + - *316 + - *317 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63294,9 +63336,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': *415 + '403': *419 '404': *6 - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63316,8 +63358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -63325,7 +63367,7 @@ paths: application/json: schema: type: array - items: &422 + items: &426 title: CodeQL Database description: A CodeQL database. type: object @@ -63437,9 +63479,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': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63466,8 +63508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - name: language in: path description: The language of the CodeQL database. @@ -63479,7 +63521,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *426 examples: default: value: @@ -63511,11 +63553,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': &452 + '302': &456 description: Found - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63535,8 +63577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *311 - - *312 + - *316 + - *317 - name: language in: path description: The language of the CodeQL database. @@ -63546,9 +63588,9 @@ paths: responses: '204': description: Response - '403': *415 + '403': *419 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63574,8 +63616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -63584,7 +63626,7 @@ paths: type: object additionalProperties: false properties: - language: &423 + language: &427 type: string description: The language targeted by the CodeQL query enum: @@ -63664,7 +63706,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &427 + schema: &431 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63672,9 +63714,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *51 + controller_repo: *55 actor: *4 - query_language: *423 + query_language: *427 query_pack_url: type: string description: The download url for the query pack. @@ -63722,7 +63764,7 @@ paths: items: type: object properties: - repository: &424 + repository: &428 title: Repository Identifier description: Repository Identifier type: object @@ -63764,7 +63806,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &428 + analysis_status: &432 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63796,7 +63838,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &425 + access_mismatch_repos: &429 type: object properties: repository_count: @@ -63811,7 +63853,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: *424 + items: *428 required: - repository_count - repositories @@ -63834,8 +63876,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *425 - over_limit_repos: *425 + no_codeql_db_repos: *429 + over_limit_repos: *429 required: - access_mismatch_repos - not_found_repos @@ -63851,7 +63893,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &426 + value: &430 summary: Default response value: id: 1 @@ -64003,17 +64045,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *426 + value: *430 repository_lists: summary: Response for a successful variant analysis submission - value: *426 + value: *430 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,8 +64076,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: - - *311 - - *312 + - *316 + - *317 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64047,11 +64089,11 @@ paths: description: Response content: application/json: - schema: *427 + schema: *431 examples: - default: *426 + default: *430 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64072,7 +64114,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: - - *311 + - *316 - name: repo in: path description: The name of the controller repository. @@ -64106,8 +64148,8 @@ paths: schema: type: object properties: - repository: *51 - analysis_status: *428 + repository: *55 + analysis_status: *432 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -64211,7 +64253,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64232,8 +64274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -64326,9 +64368,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64347,8 +64389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -64417,7 +64459,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -64442,7 +64484,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *415 + '403': *419 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64456,7 +64498,7 @@ paths: content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64513,8 +64555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -64522,7 +64564,7 @@ paths: schema: type: object properties: - commit_sha: *429 + commit_sha: *433 ref: type: string description: |- @@ -64582,7 +64624,7 @@ paths: schema: type: object properties: - id: *420 + id: *424 url: type: string description: The REST API URL for checking the status of the upload. @@ -64596,11 +64638,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': *415 + '403': *419 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64619,8 +64661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *311 - - *312 + - *316 + - *317 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -64668,10 +64710,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': *409 + '403': *413 '404': description: Not Found if the sarif id does not match any upload - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64693,8 +64735,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -64718,7 +64760,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *41 + configuration: *45 examples: default: value: @@ -64750,7 +64792,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': *168 + '204': *174 '304': *35 '403': *27 '404': *6 @@ -64775,8 +64817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *311 - - *312 + - *316 + - *317 - 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 @@ -64904,8 +64946,8 @@ paths: parameters: - *17 - *19 - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -64921,7 +64963,7 @@ paths: type: integer codespaces: type: array - items: *213 + items: *219 examples: default: value: @@ -65197,7 +65239,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': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -65219,8 +65261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -65284,22 +65326,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65323,8 +65365,8 @@ paths: parameters: - *17 - *19 - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -65364,7 +65406,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *96 + '500': *102 '400': *14 '401': *23 '403': *27 @@ -65388,8 +65430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65426,9 +65468,9 @@ paths: type: integer machines: type: array - items: *431 + items: *435 examples: - default: &645 + default: &647 value: total_count: 2 machines: @@ -65445,7 +65487,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -65468,8 +65510,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *311 - - *312 + - *316 + - *317 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65556,8 +65598,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: - - *311 - - *312 + - *316 + - *317 - 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 @@ -65605,7 +65647,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65626,8 +65668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -65645,7 +65687,7 @@ paths: type: integer secrets: type: array - items: &435 + items: &439 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65666,9 +65708,9 @@ paths: - created_at - updated_at examples: - default: *432 + default: *436 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65689,16 +65731,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *433 + schema: *437 examples: - default: *434 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65718,17 +65760,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '200': description: Response content: application/json: - schema: *435 + schema: *439 examples: - default: *436 + default: *440 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65748,9 +65790,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 requestBody: required: true content: @@ -65778,7 +65820,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -65802,9 +65844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '204': description: Response @@ -65832,8 +65874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *311 - - *312 + - *316 + - *317 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -65871,7 +65913,7 @@ paths: application/json: schema: type: array - items: &437 + items: &441 title: Collaborator description: Collaborator type: object @@ -66039,7 +66081,7 @@ paths: admin: false role_name: write headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -66064,9 +66106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 responses: '204': description: Response if user is a collaborator @@ -66112,9 +66154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 requestBody: required: false content: @@ -66140,7 +66182,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &501 + schema: &505 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66152,7 +66194,7 @@ paths: format: int64 examples: - 42 - repository: *136 + repository: *142 invitee: anyOf: - type: 'null' @@ -66328,7 +66370,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: *111 '403': *27 x-github: triggersNotification: true @@ -66368,9 +66410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 responses: '204': description: No Content when collaborator was removed from the repository. @@ -66401,9 +66443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 responses: '200': description: if user has admin permissions @@ -66423,7 +66465,7 @@ paths: user: anyOf: - type: 'null' - - *437 + - *441 required: - permission - role_name @@ -66477,8 +66519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -66488,7 +66530,7 @@ paths: application/json: schema: type: array - items: &438 + items: &442 title: Commit Comment description: Commit Comment type: object @@ -66529,8 +66571,8 @@ paths: updated_at: type: string format: date-time - author_association: *65 - reactions: *66 + author_association: *69 + reactions: *70 required: - url - html_url @@ -66546,7 +66588,7 @@ paths: - created_at - updated_at examples: - default: &441 + default: &445 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66580,7 +66622,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66605,17 +66647,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '200': description: Response content: application/json: - schema: *438 + schema: *442 examples: - default: &442 + default: &446 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66672,9 +66714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -66696,7 +66738,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: default: value: @@ -66747,9 +66789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '204': description: Response @@ -66770,9 +66812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *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. @@ -66798,11 +66840,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -66821,9 +66863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -66855,16 +66897,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -66886,10 +66928,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *311 - - *312 - - *77 - - *307 + - *316 + - *317 + - *81 + - *314 responses: '204': description: Response @@ -66938,8 +66980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *311 - - *312 + - *316 + - *317 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -66995,9 +67037,9 @@ paths: application/json: schema: type: array - items: *439 + items: *443 examples: - default: &551 + default: &555 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67067,11 +67109,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *52 - '500': *96 + Link: *56 + '500': *102 '400': *14 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67091,9 +67133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *311 - - *312 - - &440 + - *316 + - *317 + - &444 name: commit_sha description: The SHA of the commit. in: path @@ -67140,7 +67182,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67165,9 +67207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 - *17 - *19 responses: @@ -67177,11 +67219,11 @@ paths: application/json: schema: type: array - items: *438 + items: *442 examples: - default: *441 + default: *445 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67207,9 +67249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 requestBody: required: true content: @@ -67244,9 +67286,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: - default: *442 + default: *446 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67274,9 +67316,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 - *17 - *19 responses: @@ -67286,9 +67328,9 @@ paths: application/json: schema: type: array - items: *443 + items: *447 examples: - default: &543 + default: &547 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -67767,8 +67809,8 @@ paths: auto_merge: draft: false headers: - Link: *52 - '409': *45 + Link: *56 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67825,11 +67867,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *311 - - *312 + - *316 + - *317 - *19 - *17 - - &444 + - &448 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)" @@ -67844,9 +67886,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: - default: &529 + default: &533 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67932,9 +67974,9 @@ paths: ..... '422': *15 '404': *6 - '500': *96 - '503': *97 - '409': *45 + '500': *102 + '503': *103 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67959,11 +68001,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *311 - - *312 - - *444 - - *445 - - *446 + - *316 + - *317 + - *448 + - *449 + - *450 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -67997,11 +68039,11 @@ paths: type: integer check_runs: type: array - items: *391 + items: *395 examples: - default: *447 + default: *451 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68024,9 +68066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *311 - - *312 - - *444 + - *316 + - *317 + - *448 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68034,7 +68076,7 @@ paths: schema: type: integer example: 1 - - *445 + - *449 - *17 - *19 responses: @@ -68052,7 +68094,7 @@ paths: type: integer check_suites: type: array - items: *395 + items: *399 examples: default: value: @@ -68227,7 +68269,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68252,9 +68294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *311 - - *312 - - *444 + - *316 + - *317 + - *448 - *17 - *19 responses: @@ -68325,7 +68367,7 @@ paths: type: string total_count: type: integer - repository: *136 + repository: *142 commit_url: type: string format: uri @@ -68456,9 +68498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *311 - - *312 - - *444 + - *316 + - *317 + - *448 - *17 - *19 responses: @@ -68468,7 +68510,7 @@ paths: application/json: schema: type: array - items: &616 + items: &620 title: Status description: The status of a commit. type: object @@ -68548,8 +68590,8 @@ paths: type: User site_admin: false headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68577,8 +68619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -68611,11 +68653,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *448 + - *452 code_of_conduct_file: anyOf: - type: 'null' - - &449 + - &453 title: Community Health File type: object properties: @@ -68631,23 +68673,23 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 contributing: anyOf: - type: 'null' - - *449 + - *453 readme: anyOf: - type: 'null' - - *449 + - *453 issue_template: anyOf: - type: 'null' - - *449 + - *453 pull_request_template: anyOf: - type: 'null' - - *449 + - *453 required: - code_of_conduct - code_of_conduct_file @@ -68776,8 +68818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *311 - - *312 + - *316 + - *317 - *19 - *17 - name: basehead @@ -68825,8 +68867,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *439 - merge_base_commit: *439 + base_commit: *443 + merge_base_commit: *443 status: type: string enum: @@ -68850,10 +68892,10 @@ paths: - 6 commits: type: array - items: *439 + items: *443 files: type: array - items: *450 + items: *454 required: - url - html_url @@ -69096,8 +69138,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69139,8 +69181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *311 - - *312 + - *316 + - *317 - name: path description: path parameter in: path @@ -69293,7 +69335,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &451 + response-if-content-is-a-file: &455 summary: Response if content is a file value: type: file @@ -69430,7 +69472,7 @@ paths: - size - type - url - - &556 + - &560 title: Content File description: Content File type: object @@ -69648,7 +69690,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *451 + response-if-content-is-a-file: *455 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69717,7 +69759,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *452 + '302': *456 '304': *35 x-github: githubCloudOnly: false @@ -69740,8 +69782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *311 - - *312 + - *316 + - *317 - name: path description: path parameter in: path @@ -69836,7 +69878,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &457 title: File Commit description: File Commit type: object @@ -69992,7 +70034,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *457 examples: example-for-creating-a-file: value: @@ -70046,7 +70088,7 @@ paths: schema: oneOf: - *3 - - &483 + - &487 description: Repository rule violation was detected type: object properties: @@ -70067,7 +70109,7 @@ paths: items: type: object properties: - placeholder_id: &608 + placeholder_id: &612 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -70099,8 +70141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *311 - - *312 + - *316 + - *317 - name: path description: path parameter in: path @@ -70161,7 +70203,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *457 examples: default: value: @@ -70195,8 +70237,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *45 - '503': *97 + '409': *49 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70216,8 +70258,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *311 - - *312 + - *316 + - *317 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -70318,7 +70360,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *52 + Link: *56 '204': description: Response if repository is empty '403': *27 @@ -70341,23 +70383,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *311 - - *312 - - *173 - - *174 - - *175 - - *176 + - *316 + - *317 + - *179 + - *180 + - *181 + - *182 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *177 - - *454 - - *178 - - *179 - - *46 + - *183 + - *458 + - *184 + - *185 + - *50 - 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)." @@ -70366,8 +70408,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -70375,11 +70417,11 @@ paths: application/json: schema: type: array - items: &457 + items: &461 type: object description: A Dependabot alert. properties: - number: *154 + number: *160 state: type: string description: The state of the Dependabot alert. @@ -70394,7 +70436,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *47 + package: *51 manifest_path: type: string description: The full path to the dependency manifest file, @@ -70425,13 +70467,13 @@ paths: - direct - transitive - - security_advisory: *455 - security_vulnerability: *50 - url: *157 - html_url: *158 - created_at: *155 - updated_at: *156 - dismissed_at: *160 + security_advisory: *459 + security_vulnerability: *54 + url: *163 + html_url: *164 + created_at: *161 + updated_at: *162 + dismissed_at: *166 dismissed_by: anyOf: - type: 'null' @@ -70455,8 +70497,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *159 - auto_dismissed_at: *456 + fixed_at: *165 + auto_dismissed_at: *460 required: - number - state @@ -70686,9 +70728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *311 - - *312 - - &458 + - *316 + - *317 + - &462 name: alert_number in: path description: |- @@ -70697,13 +70739,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *154 + schema: *160 responses: '200': description: Response content: application/json: - schema: *457 + schema: *461 examples: default: value: @@ -70816,9 +70858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *311 - - *312 - - *458 + - *316 + - *317 + - *462 requestBody: required: true content: @@ -70863,7 +70905,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *461 examples: default: value: @@ -70969,7 +71011,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *7 x-github: githubCloudOnly: false @@ -70992,8 +71034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -71011,7 +71053,7 @@ paths: type: integer secrets: type: array - items: &461 + items: &465 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -71043,7 +71085,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71065,16 +71107,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *459 + schema: *463 examples: - default: *460 + default: *464 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71094,15 +71136,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '200': description: Response content: application/json: - schema: *461 + schema: *465 examples: default: value: @@ -71128,9 +71170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 requestBody: required: true content: @@ -71158,7 +71200,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -71182,9 +71224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '204': description: Response @@ -71206,8 +71248,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: - - *311 - - *312 + - *316 + - *317 - 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 @@ -71357,7 +71399,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *52 + Link: *56 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -71381,8 +71423,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -71619,7 +71661,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *52 + Link: *56 '404': *6 '403': *27 x-github: @@ -71642,8 +71684,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -71726,7 +71768,7 @@ paths: - version - url additionalProperties: false - metadata: &462 + metadata: &466 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71765,7 +71807,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *462 + metadata: *466 resolved: type: object description: A collection of resolved package dependencies. @@ -71779,7 +71821,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *462 + metadata: *466 relationship: type: string description: A notation of whether a dependency is requested @@ -71912,8 +71954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *311 - - *312 + - *316 + - *317 - name: sha description: The SHA recorded at creation time. in: query @@ -71954,11 +71996,11 @@ paths: application/json: schema: type: array - items: *463 + items: *467 examples: - default: *464 + default: *468 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72022,8 +72064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -72105,7 +72147,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: simple-example: summary: Simple example @@ -72178,9 +72220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *311 - - *312 - - &465 + - *316 + - *317 + - &469 name: deployment_id description: deployment_id parameter in: path @@ -72192,7 +72234,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: default: value: @@ -72257,9 +72299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 responses: '204': description: Response @@ -72281,9 +72323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 - *17 - *19 responses: @@ -72293,7 +72335,7 @@ paths: application/json: schema: type: array - items: &466 + items: &470 title: Deployment Status description: The status of a deployment. type: object @@ -72437,7 +72479,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -72457,9 +72499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 requestBody: required: true content: @@ -72534,9 +72576,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: &467 + default: &471 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72592,9 +72634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 - name: status_id in: path required: true @@ -72605,9 +72647,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *467 + default: *471 '404': *6 x-github: githubCloudOnly: false @@ -72632,8 +72674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -72690,8 +72732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -72709,7 +72751,7 @@ paths: - 5 environments: type: array - items: &469 + items: &473 title: Environment description: Details of a deployment environment type: object @@ -72771,7 +72813,7 @@ paths: type: string examples: - wait_timer - wait_timer: &471 + wait_timer: &475 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -72813,11 +72855,11 @@ paths: items: type: object properties: - type: *468 + type: *472 reviewer: anyOf: - *4 - - *172 + - *178 required: - id - node_id @@ -72840,7 +72882,7 @@ paths: - id - node_id - type - deployment_branch_policy: &472 + deployment_branch_policy: &476 type: - object - 'null' @@ -72957,9 +72999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *311 - - *312 - - &470 + - *316 + - *317 + - &474 name: environment_name in: path required: true @@ -72972,9 +73014,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *473 examples: - default: &473 + default: &477 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -73058,9 +73100,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 requestBody: required: false content: @@ -73070,7 +73112,7 @@ paths: - object - 'null' properties: - wait_timer: *471 + wait_timer: *475 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -73089,14 +73131,14 @@ paths: items: type: object properties: - type: *468 + type: *472 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *472 + deployment_branch_policy: *476 additionalProperties: false examples: default: @@ -73116,9 +73158,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *473 examples: - default: *473 + default: *477 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -73142,9 +73184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 responses: '204': description: Default response @@ -73169,9 +73211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 - *17 - *19 responses: @@ -73190,7 +73232,7 @@ paths: - 2 branch_policies: type: array - items: &474 + items: &478 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -73251,9 +73293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 requestBody: required: true content: @@ -73301,9 +73343,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: - example-wildcard: &475 + example-wildcard: &479 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73345,10 +73387,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 - - &476 + - *316 + - *317 + - *474 + - &480 name: branch_policy_id in: path required: true @@ -73360,9 +73402,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: - default: *475 + default: *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73381,10 +73423,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 - - *476 + - *316 + - *317 + - *474 + - *480 requestBody: required: true content: @@ -73413,9 +73455,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: - default: *475 + default: *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73434,10 +73476,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 - - *476 + - *316 + - *317 + - *474 + - *480 responses: '204': description: Response @@ -73462,9 +73504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *470 - - *312 - - *311 + - *474 + - *317 + - *316 responses: '200': description: List of deployment protection rules @@ -73481,7 +73523,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &477 + items: &481 title: Deployment protection rule description: Deployment protection rule type: object @@ -73503,7 +73545,7 @@ paths: for the environment. examples: - true - app: &478 + app: &482 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73606,9 +73648,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: - - *470 - - *312 - - *311 + - *474 + - *317 + - *316 requestBody: content: application/json: @@ -73629,9 +73671,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *477 + schema: *481 examples: - default: &479 + default: &483 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73666,9 +73708,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: - - *470 - - *312 - - *311 + - *474 + - *317 + - *316 - *19 - *17 responses: @@ -73688,7 +73730,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *478 + items: *482 examples: default: value: @@ -73723,10 +73765,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *311 - - *312 - - *470 - - &480 + - *316 + - *317 + - *474 + - &484 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73738,9 +73780,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *481 examples: - default: *479 + default: *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73761,10 +73803,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *470 - - *312 - - *311 - - *480 + - *474 + - *317 + - *316 + - *484 responses: '204': description: Response @@ -73790,9 +73832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 - *17 - *19 responses: @@ -73810,11 +73852,11 @@ paths: type: integer secrets: type: array - items: *357 + items: *361 examples: - default: *358 + default: *362 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73837,17 +73879,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 responses: '200': description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73869,18 +73911,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *311 - - *312 - - *470 - - *144 + - *316 + - *317 + - *474 + - *150 responses: '200': description: Response content: application/json: - schema: *357 + schema: *361 examples: - default: *481 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73902,10 +73944,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *311 - - *312 - - *470 - - *144 + - *316 + - *317 + - *474 + - *150 requestBody: required: true content: @@ -73936,7 +73978,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -73962,10 +74004,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *311 - - *312 - - *470 - - *144 + - *316 + - *317 + - *474 + - *150 responses: '204': description: Default response @@ -73990,10 +74032,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *311 - - *312 - - *470 - - *328 + - *316 + - *317 + - *474 + - *332 - *19 responses: '200': @@ -74010,11 +74052,11 @@ paths: type: integer variables: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74035,9 +74077,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 requestBody: required: true content: @@ -74064,7 +74106,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -74089,18 +74131,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *311 - - *312 - - *470 - - *147 + - *316 + - *317 + - *474 + - *153 responses: '200': description: Response content: application/json: - schema: *361 + schema: *365 examples: - default: *482 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74121,10 +74163,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *311 - - *312 - - *147 - - *470 + - *316 + - *317 + - *153 + - *474 requestBody: required: true content: @@ -74166,10 +74208,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *311 - - *312 - - *147 - - *470 + - *316 + - *317 + - *153 + - *474 responses: '204': description: Response @@ -74191,8 +74233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -74202,7 +74244,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: 200-response: value: @@ -74260,8 +74302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *311 - - *312 + - *316 + - *317 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -74283,7 +74325,7 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: default: value: @@ -74396,7 +74438,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *52 + Link: *56 '400': *14 x-github: githubCloudOnly: false @@ -74420,8 +74462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -74454,9 +74496,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 '400': *14 '422': *15 '403': *27 @@ -74477,8 +74519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -74529,7 +74571,7 @@ paths: schema: type: string '404': *6 - '409': *45 + '409': *49 '403': *27 '422': description: Validation failed @@ -74537,8 +74579,8 @@ paths: application/json: schema: oneOf: - - *105 - - *483 + - *111 + - *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74563,8 +74605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *311 - - *312 + - *316 + - *317 - name: file_sha in: path required: true @@ -74616,7 +74658,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74664,8 +74706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -74774,7 +74816,7 @@ paths: description: Response content: application/json: - schema: &484 + schema: &488 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -74951,7 +74993,7 @@ paths: type: string '422': *15 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75001,15 +75043,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 responses: '200': description: Response content: application/json: - schema: *484 + schema: *488 examples: default: value: @@ -75040,7 +75082,7 @@ paths: payload: verified_at: '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75065,9 +75107,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *311 - - *312 - - &485 + - *316 + - *317 + - &489 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. @@ -75084,7 +75126,7 @@ paths: application/json: schema: type: array - items: &486 + items: &490 title: Git Reference description: Git references within a repository type: object @@ -75138,8 +75180,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *52 - '409': *45 + Link: *56 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75160,17 +75202,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *311 - - *312 - - *485 + - *316 + - *317 + - *489 responses: '200': description: Response content: application/json: - schema: *486 + schema: *490 examples: - default: &487 + default: &491 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -75180,7 +75222,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75199,8 +75241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -75229,16 +75271,16 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: - default: *487 + default: *491 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75257,9 +75299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *311 - - *312 - - *485 + - *316 + - *317 + - *489 requestBody: required: true content: @@ -75288,11 +75330,11 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: - default: *487 + default: *491 '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75308,16 +75350,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *311 - - *312 - - *485 + - *316 + - *317 + - *489 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75365,8 +75407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -75433,7 +75475,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &493 title: Git Tag description: Metadata for a Git tag type: object @@ -75489,7 +75531,7 @@ paths: - sha - type - url - verification: *488 + verification: *492 required: - sha - url @@ -75499,7 +75541,7 @@ paths: - tag - message examples: - default: &490 + default: &494 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75526,7 +75568,7 @@ paths: schema: type: string '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75572,8 +75614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *311 - - *312 + - *316 + - *317 - name: tag_sha in: path required: true @@ -75584,11 +75626,11 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: *490 + default: *494 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75610,8 +75652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -75685,7 +75727,7 @@ paths: description: Response content: application/json: - schema: &491 + schema: &495 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75764,7 +75806,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75787,8 +75829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *311 - - *312 + - *316 + - *317 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -75811,7 +75853,7 @@ paths: description: Response content: application/json: - schema: *491 + schema: *495 examples: default-response: summary: Default response @@ -75852,7 +75894,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75870,8 +75912,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -75881,7 +75923,7 @@ paths: application/json: schema: type: array - items: &492 + items: &496 title: Webhook description: Webhooks for repositories. type: object @@ -75944,7 +75986,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &720 + last_response: &731 title: Hook Response type: object properties: @@ -76002,7 +76044,7 @@ paths: status: unused message: headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -76021,8 +76063,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -76075,9 +76117,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: &493 + default: &497 value: type: Repository id: 12345678 @@ -76125,17 +76167,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '200': description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *493 + default: *497 '404': *6 x-github: githubCloudOnly: false @@ -76155,9 +76197,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 requestBody: required: true content: @@ -76202,9 +76244,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *493 + default: *497 '422': *15 '404': *6 x-github: @@ -76225,9 +76267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '204': description: Response @@ -76251,9 +76293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '200': description: Response @@ -76280,9 +76322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 requestBody: required: false content: @@ -76326,11 +76368,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 - *17 - - *186 + - *192 responses: '200': description: Response @@ -76338,9 +76380,9 @@ paths: application/json: schema: type: array - items: *187 + items: *193 examples: - default: *188 + default: *194 '400': *14 '422': *15 x-github: @@ -76359,18 +76401,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 - *16 responses: '200': description: Response content: application/json: - schema: *189 + schema: *195 examples: - default: *190 + default: *196 '400': *14 '422': *15 x-github: @@ -76389,9 +76431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 - *16 responses: '202': *37 @@ -76414,9 +76456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '204': description: Response @@ -76441,9 +76483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '204': description: Response @@ -76466,8 +76508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response if immutable releases are enabled @@ -76515,11 +76557,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 - '409': *45 + '204': *174 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76536,11 +76578,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 - '409': *45 + '204': *174 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76594,14 +76636,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: &494 + schema: &498 title: Import description: A repository import from an external source. type: object @@ -76708,7 +76750,7 @@ paths: - html_url - authors_url examples: - default: &497 + default: &501 value: vcs: subversion use_lfs: true @@ -76724,7 +76766,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': &495 + '503': &499 description: Unavailable due to service under maintenance. content: application/json: @@ -76753,8 +76795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -76802,7 +76844,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *498 examples: default: value: @@ -76827,7 +76869,7 @@ paths: type: string '422': *15 '404': *6 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76855,8 +76897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -76908,7 +76950,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *498 examples: example-1: summary: Example 1 @@ -76956,7 +76998,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': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76979,12 +77021,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77010,9 +77052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *311 - - *312 - - &666 + - *316 + - *317 + - &668 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77026,7 +77068,7 @@ paths: application/json: schema: type: array - items: &496 + items: &500 title: Porter Author description: Porter Author type: object @@ -77080,7 +77122,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': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77105,8 +77147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *311 - - *312 + - *316 + - *317 - name: author_id in: path required: true @@ -77136,7 +77178,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *500 examples: default: value: @@ -77149,7 +77191,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77173,8 +77215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -77215,7 +77257,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77243,8 +77285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -77271,11 +77313,11 @@ paths: description: Response content: application/json: - schema: *494 + schema: *498 examples: - default: *497 + default: *501 '422': *15 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77298,8 +77340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -77307,8 +77349,8 @@ paths: application/json: schema: *20 examples: - default: *498 - '301': *318 + default: *502 + '301': *320 '404': *6 x-github: githubCloudOnly: false @@ -77328,8 +77370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -77337,12 +77379,12 @@ paths: application/json: schema: anyOf: - - *203 + - *209 - type: object properties: {} additionalProperties: false examples: - default: &500 + default: &504 value: limit: collaborators_only origin: repository @@ -77367,13 +77409,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: application/json: - schema: *499 + schema: *503 examples: default: summary: Example request body @@ -77385,9 +77427,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *209 examples: - default: *500 + default: *504 '409': description: Response x-github: @@ -77409,8 +77451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -77433,8 +77475,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -77444,9 +77486,9 @@ paths: application/json: schema: type: array - items: *501 + items: *505 examples: - default: &659 + default: &661 value: - id: 1 repository: @@ -77560,7 +77602,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77577,9 +77619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *311 - - *312 - - *207 + - *316 + - *317 + - *213 requestBody: required: false content: @@ -77608,7 +77650,7 @@ paths: description: Response content: application/json: - schema: *501 + schema: *505 examples: default: value: @@ -77739,9 +77781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *311 - - *312 - - *207 + - *316 + - *317 + - *213 responses: '204': description: Response @@ -77772,8 +77814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *311 - - *312 + - *316 + - *317 - 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 @@ -77821,7 +77863,7 @@ paths: required: false schema: type: string - - *211 + - *217 - name: sort description: What to sort results by. in: query @@ -77833,8 +77875,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - *17 - *19 responses: @@ -77844,9 +77886,9 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: &509 + default: &513 value: - id: 1 node_id: MDU6SXNzdWUx @@ -77993,8 +78035,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '422': *15 '404': *6 x-github: @@ -78023,8 +78065,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -78114,9 +78156,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: &506 + default: &510 value: id: 1 node_id: MDU6SXNzdWUx @@ -78270,9 +78312,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *97 + '503': *103 '404': *6 - '410': *502 + '410': *506 x-github: triggersNotification: true githubCloudOnly: false @@ -78300,9 +78342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *311 - - *312 - - *87 + - *316 + - *317 + - *91 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -78312,7 +78354,7 @@ paths: enum: - asc - desc - - *68 + - *72 - *17 - *19 responses: @@ -78322,9 +78364,9 @@ paths: application/json: schema: type: array - items: *503 + items: *507 examples: - default: &508 + default: &512 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78355,7 +78397,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *52 + Link: *56 '422': *15 '404': *6 x-github: @@ -78382,17 +78424,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '200': description: Response content: application/json: - schema: *503 + schema: *507 examples: - default: &504 + default: &508 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78446,9 +78488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -78470,9 +78512,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *507 examples: - default: *504 + default: *508 '422': *15 x-github: githubCloudOnly: false @@ -78490,9 +78532,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '204': description: Response @@ -78512,9 +78554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *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. @@ -78540,11 +78582,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -78563,9 +78605,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -78597,16 +78639,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -78628,10 +78670,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *311 - - *312 - - *77 - - *307 + - *316 + - *317 + - *81 + - *314 responses: '204': description: Response @@ -78651,8 +78693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -78662,7 +78704,7 @@ paths: application/json: schema: type: array - items: &505 + items: &509 title: Issue Event description: Issue Event type: object @@ -78709,7 +78751,7 @@ paths: issue: anyOf: - type: 'null' - - *78 + - *82 label: title: Issue Event Label description: Issue Event Label @@ -78742,7 +78784,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *172 + requested_team: *178 dismissed_review: title: Issue Event Dismissed Review type: object @@ -78809,7 +78851,7 @@ paths: required: - from - to - author_association: *65 + author_association: *69 lock_reason: type: - string @@ -78983,7 +79025,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -79001,8 +79043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *311 - - *312 + - *316 + - *317 - name: event_id in: path required: true @@ -79013,7 +79055,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *509 examples: default: value: @@ -79190,7 +79232,6 @@ paths: metadata: read contents: read issues: write - single_file: write events: - push - pull_request @@ -79206,7 +79247,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *502 + '410': *506 '403': *27 x-github: githubCloudOnly: false @@ -79240,9 +79281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *311 - - *312 - - &507 + - *316 + - *317 + - &511 name: issue_number description: The number that identifies the issue. in: path @@ -79254,12 +79295,12 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 - '301': *318 + default: *510 + '301': *320 '404': *6 - '410': *502 + '410': *506 '304': *35 x-github: githubCloudOnly: false @@ -79284,9 +79325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -79405,15 +79446,15 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 '422': *15 - '503': *97 + '503': *103 '403': *27 - '301': *318 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79431,9 +79472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -79459,9 +79500,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79477,9 +79518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: content: application/json: @@ -79504,9 +79545,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79528,9 +79569,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: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - name: assignee in: path required: true @@ -79570,10 +79611,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *311 - - *312 - - *507 - - *68 + - *316 + - *317 + - *511 + - *72 - *17 - *19 responses: @@ -79583,13 +79624,13 @@ paths: application/json: schema: type: array - items: *503 + items: *507 examples: - default: *508 + default: *512 headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79618,9 +79659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -79642,16 +79683,16 @@ paths: description: Response content: application/json: - schema: *503 + schema: *507 examples: - default: *504 + default: *508 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *502 + '410': *506 '422': *15 '404': *6 x-github: @@ -79679,9 +79720,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -79691,14 +79732,14 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *509 + default: *513 headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79726,9 +79767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -79750,17 +79791,17 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *318 + '301': *320 '403': *27 - '410': *502 + '410': *506 '422': *15 '404': *6 x-github: @@ -79791,9 +79832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -79805,15 +79846,15 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 - '301': *318 + default: *510 + '301': *320 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *502 + '410': *506 x-github: triggersNotification: true githubCloudOnly: false @@ -79839,9 +79880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -79851,14 +79892,14 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *509 + default: *513 headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79875,9 +79916,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -79891,7 +79932,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &512 + - &516 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -79940,7 +79981,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &513 + - &517 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -80068,7 +80109,7 @@ paths: - performed_via_github_app - assignee - assigner - - &514 + - &518 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -80114,7 +80155,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &519 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -80160,7 +80201,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &516 + - &520 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -80209,7 +80250,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &521 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -80238,7 +80279,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *172 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -80251,7 +80292,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &522 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -80280,7 +80321,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *172 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -80293,7 +80334,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &523 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80349,7 +80390,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &524 title: Locked Issue Event description: Locked Issue Event type: object @@ -80394,7 +80435,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &525 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -80455,7 +80496,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &526 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -80516,7 +80557,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &527 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -80577,7 +80618,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &528 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -80669,8 +80710,8 @@ paths: name: label color: red headers: - Link: *52 - '410': *502 + Link: *56 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80687,9 +80728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -80699,7 +80740,7 @@ paths: application/json: schema: type: array - items: &510 + items: &514 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -80754,7 +80795,7 @@ paths: - color - default examples: - default: &511 + default: &515 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80771,10 +80812,10 @@ paths: color: a2eeef default: false headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80791,9 +80832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -80852,12 +80893,12 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 - '301': *318 + default: *515 + '301': *320 '404': *6 - '410': *502 + '410': *506 '422': *15 x-github: githubCloudOnly: false @@ -80874,9 +80915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -80936,12 +80977,12 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 - '301': *318 + default: *515 + '301': *320 '404': *6 - '410': *502 + '410': *506 '422': *15 x-github: githubCloudOnly: false @@ -80958,15 +80999,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 responses: '204': description: Response - '301': *318 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80985,9 +81026,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - name: name in: path required: true @@ -81000,7 +81041,7 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: default: value: @@ -81011,9 +81052,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *318 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81033,9 +81074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -81064,7 +81105,7 @@ paths: '204': description: Response '403': *27 - '410': *502 + '410': *506 '404': *6 '422': *15 x-github: @@ -81082,9 +81123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 responses: '204': description: Response @@ -81114,20 +81155,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 responses: '200': description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 - '301': *318 + default: *510 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81144,9 +81185,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - 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. @@ -81172,13 +81213,13 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81196,9 +81237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81230,16 +81271,16 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -81261,10 +81302,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *311 - - *312 - - *507 - - *307 + - *316 + - *317 + - *511 + - *314 responses: '204': description: Response @@ -81293,9 +81334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81317,9 +81358,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81352,9 +81393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -81364,13 +81405,13 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *509 + default: *513 headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81398,9 +81439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81427,16 +81468,16 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *502 + '410': *506 '422': *15 '404': *6 x-github: @@ -81456,9 +81497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81489,13 +81530,13 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 '403': *27 '404': *6 '422': *7 - '503': *97 + '503': *103 x-github: triggersNotification: true githubCloudOnly: false @@ -81513,9 +81554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -81530,10 +81571,6 @@ paths: description: Timeline Event type: object anyOf: - - *512 - - *513 - - *514 - - *515 - *516 - *517 - *518 @@ -81543,6 +81580,10 @@ paths: - *522 - *523 - *524 + - *525 + - *526 + - *527 + - *528 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -81590,12 +81631,12 @@ paths: issue_url: type: string format: uri - author_association: *65 + author_association: *69 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *66 + reactions: *70 required: - event - actor @@ -81626,7 +81667,7 @@ paths: properties: type: type: string - issue: *78 + issue: *82 required: - event - created_at @@ -81848,7 +81889,7 @@ paths: type: string body_text: type: string - author_association: *65 + author_association: *69 required: - event - id @@ -81871,7 +81912,7 @@ paths: type: string comments: type: array - items: &545 + items: &549 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -81976,7 +82017,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *65 + author_association: *69 _links: type: object properties: @@ -82071,7 +82112,7 @@ paths: enum: - line - file - reactions: *66 + reactions: *70 body_html: type: string examples: @@ -82109,7 +82150,7 @@ paths: type: string comments: type: array - items: *438 + items: *442 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82382,9 +82423,9 @@ paths: type: User site_admin: true headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82401,8 +82442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -82412,7 +82453,7 @@ paths: application/json: schema: type: array - items: &525 + items: &529 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -82464,7 +82505,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82480,8 +82521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -82517,9 +82558,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *529 examples: - default: &526 + default: &530 value: id: 1 key: ssh-rsa AAA... @@ -82553,9 +82594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *311 - - *312 - - &527 + - *316 + - *317 + - &531 name: key_id description: The unique identifier of the key. in: path @@ -82567,9 +82608,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *529 examples: - default: *526 + default: *530 '404': *6 x-github: githubCloudOnly: false @@ -82587,9 +82628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *311 - - *312 - - *527 + - *316 + - *317 + - *531 responses: '204': description: Response @@ -82609,8 +82650,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -82620,11 +82661,11 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 + default: *515 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -82643,8 +82684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -82680,9 +82721,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: - default: &528 + default: &532 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82714,8 +82755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *311 - - *312 + - *316 + - *317 - name: name in: path required: true @@ -82726,9 +82767,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: - default: *528 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -82745,8 +82786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *311 - - *312 + - *316 + - *317 - name: name in: path required: true @@ -82785,7 +82826,7 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: default: value: @@ -82811,8 +82852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *311 - - *312 + - *316 + - *317 - name: name in: path required: true @@ -82838,8 +82879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -82878,9 +82919,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *311 - - *312 - - *416 + - *316 + - *317 + - *420 responses: '200': description: Response @@ -82946,7 +82987,7 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 required: - _links - git_url @@ -83027,8 +83068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83093,8 +83134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83128,9 +83169,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *439 + schema: *443 examples: - default: *529 + default: *533 '204': description: Response when already merged '404': @@ -83155,8 +83196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *311 - - *312 + - *316 + - *317 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -83197,7 +83238,7 @@ paths: application/json: schema: type: array - items: *244 + items: *250 examples: default: value: @@ -83236,7 +83277,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -83253,8 +83294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83294,9 +83335,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: &530 + default: &534 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83355,9 +83396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *311 - - *312 - - &531 + - *316 + - *317 + - &535 name: milestone_number description: The number that identifies the milestone. in: path @@ -83369,9 +83410,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *530 + default: *534 '404': *6 x-github: githubCloudOnly: false @@ -83388,9 +83429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *311 - - *312 - - *531 + - *316 + - *317 + - *535 requestBody: required: false content: @@ -83428,9 +83469,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83446,9 +83487,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *311 - - *312 - - *531 + - *316 + - *317 + - *535 responses: '204': description: Response @@ -83469,9 +83510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *311 - - *312 - - *531 + - *316 + - *317 + - *535 - *17 - *19 responses: @@ -83481,11 +83522,11 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 + default: *515 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83502,12 +83543,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *311 - - *312 - - *532 - - *533 - - *68 - - *534 + - *316 + - *317 + - *536 + - *537 + - *72 + - *538 - *17 - *19 responses: @@ -83517,11 +83558,11 @@ paths: application/json: schema: type: array - items: *90 + items: *94 examples: - default: *535 + default: *539 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -83543,8 +83584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -83602,14 +83643,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: &536 + schema: &540 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -83753,7 +83794,7 @@ paths: - custom_404 - public examples: - default: &537 + default: &541 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -83794,8 +83835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83850,11 +83891,11 @@ paths: description: Response content: application/json: - schema: *536 + schema: *540 examples: - default: *537 + default: *541 '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83875,8 +83916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83955,7 +83996,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83976,14 +84017,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response '422': *15 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84003,8 +84044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -84014,7 +84055,7 @@ paths: application/json: schema: type: array - items: &538 + items: &542 title: Page Build description: Page Build type: object @@ -84087,7 +84128,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84106,8 +84147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *311 - - *312 + - *316 + - *317 responses: '201': description: Response @@ -84154,16 +84195,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *538 + schema: *542 examples: - default: &539 + default: &543 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -84211,8 +84252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *311 - - *312 + - *316 + - *317 - name: build_id in: path required: true @@ -84223,9 +84264,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *542 examples: - default: *539 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84245,8 +84286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -84354,9 +84395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *311 - - *312 - - &540 + - *316 + - *317 + - &544 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84414,11 +84455,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *311 - - *312 - - *540 + - *316 + - *317 + - *544 responses: - '204': *168 + '204': *174 '404': *6 x-github: githubCloudOnly: false @@ -84443,8 +84484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -84712,7 +84753,7 @@ paths: description: Empty response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -84739,8 +84780,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Private vulnerability reporting status @@ -84777,10 +84818,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 + '204': *174 '422': *14 x-github: githubCloudOnly: false @@ -84799,10 +84840,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 + '204': *174 '422': *14 x-github: githubCloudOnly: false @@ -84822,8 +84863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -84831,9 +84872,9 @@ paths: application/json: schema: type: array - items: *95 + items: *101 examples: - default: *541 + default: *545 '403': *27 '404': *6 x-github: @@ -84855,8 +84896,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -84868,11 +84909,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *95 + items: *101 required: - properties examples: - default: *542 + default: *546 responses: '204': description: No Content when custom property values are successfully created @@ -84910,8 +84951,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *311 - - *312 + - *316 + - *317 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -84971,11 +85012,11 @@ paths: application/json: schema: type: array - items: *443 + items: *447 examples: - default: *543 + default: *547 headers: - Link: *52 + Link: *56 '304': *35 '422': *15 x-github: @@ -85005,8 +85046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -85073,7 +85114,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &551 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85202,7 +85243,7 @@ paths: milestone: anyOf: - type: 'null' - - *244 + - *250 active_lock_reason: type: - string @@ -85257,7 +85298,7 @@ paths: type: - array - 'null' - items: *223 + items: *229 head: type: object properties: @@ -85265,7 +85306,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: *4 @@ -85282,7 +85323,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: *4 @@ -85295,14 +85336,14 @@ paths: _links: type: object properties: - comments: *245 - commits: *245 - statuses: *245 - html: *245 - issue: *245 - review_comments: *245 - review_comment: *245 - self: *245 + comments: *251 + commits: *251 + statuses: *251 + html: *251 + issue: *251 + review_comments: *251 + review_comment: *251 + self: *251 required: - comments - commits @@ -85312,8 +85353,8 @@ paths: - review_comments - review_comment - self - author_association: *65 - auto_merge: *544 + author_association: *69 + auto_merge: *548 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -85415,7 +85456,7 @@ paths: - merged_by - review_comments examples: - default: &548 + default: &552 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -85942,8 +85983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - name: sort in: query required: false @@ -85962,7 +86003,7 @@ paths: enum: - asc - desc - - *68 + - *72 - *17 - *19 responses: @@ -85972,9 +86013,9 @@ paths: application/json: schema: type: array - items: *545 + items: *549 examples: - default: &550 + default: &554 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86026,7 +86067,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86051,17 +86092,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '200': description: Response content: application/json: - schema: *545 + schema: *549 examples: - default: &546 + default: &550 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86136,9 +86177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -86160,9 +86201,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *549 examples: - default: *546 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86178,9 +86219,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '204': description: Response @@ -86201,9 +86242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *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. @@ -86229,11 +86270,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -86252,9 +86293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -86286,16 +86327,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -86317,10 +86358,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *311 - - *312 - - *77 - - *307 + - *316 + - *317 + - *81 + - *314 responses: '204': description: Response @@ -86363,9 +86404,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *311 - - *312 - - &549 + - *316 + - *317 + - &553 name: pull_number description: The number that identifies the pull request. in: path @@ -86378,9 +86419,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *547 + schema: *551 examples: - default: *548 + default: *552 '304': *35 '404': *6 '406': @@ -86388,8 +86429,8 @@ paths: content: application/json: schema: *3 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86415,9 +86456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -86459,9 +86500,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *551 examples: - default: *548 + default: *552 '422': *15 '403': *27 x-github: @@ -86483,9 +86524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: true content: @@ -86546,21 +86587,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '401': *23 '403': *27 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86586,10 +86627,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *311 - - *312 - - *549 - - *87 + - *316 + - *317 + - *553 + - *91 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -86599,7 +86640,7 @@ paths: enum: - asc - desc - - *68 + - *72 - *17 - *19 responses: @@ -86609,11 +86650,11 @@ paths: application/json: schema: type: array - items: *545 + items: *549 examples: - default: *550 + default: *554 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86644,9 +86685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: true content: @@ -86752,7 +86793,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *549 examples: example-for-a-multi-line-comment: value: @@ -86840,10 +86881,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *311 - - *312 - - *549 - - *77 + - *316 + - *317 + - *553 + - *81 requestBody: required: true content: @@ -86865,7 +86906,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *549 examples: default: value: @@ -86951,9 +86992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 - *17 - *19 responses: @@ -86963,11 +87004,11 @@ paths: application/json: schema: type: array - items: *439 + items: *443 examples: - default: *551 + default: *555 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86995,9 +87036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 - *17 - *19 responses: @@ -87007,7 +87048,7 @@ paths: application/json: schema: type: array - items: *450 + items: *454 examples: default: value: @@ -87023,10 +87064,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *52 + Link: *56 '422': *15 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87045,9 +87086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 responses: '204': description: Response if pull request has been merged @@ -87070,9 +87111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -87184,9 +87225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 responses: '200': description: Response @@ -87202,7 +87243,7 @@ paths: items: *4 teams: type: array - items: *172 + items: *178 required: - users - teams @@ -87243,7 +87284,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87261,9 +87302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -87300,7 +87341,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *447 examples: default: value: @@ -87836,9 +87877,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: true content: @@ -87872,7 +87913,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *447 examples: default: value: @@ -88377,9 +88418,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 - *17 - *19 responses: @@ -88389,7 +88430,7 @@ paths: application/json: schema: type: array - items: &552 + items: &556 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -88463,7 +88504,7 @@ paths: type: string body_text: type: string - author_association: *65 + author_association: *69 required: - id - node_id @@ -88512,7 +88553,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88545,9 +88586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -88637,9 +88678,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: &554 + default: &558 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88702,10 +88743,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 - - &553 + - *316 + - *317 + - *553 + - &557 name: review_id description: The unique identifier of the review. in: path @@ -88717,9 +88758,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: &555 + default: &559 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88778,10 +88819,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 requestBody: required: true content: @@ -88804,7 +88845,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: default: value: @@ -88866,18 +88907,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 responses: '200': description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: *554 + default: *558 '422': *7 '404': *6 x-github: @@ -88904,10 +88945,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 - *17 - *19 responses: @@ -89001,13 +89042,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *65 + author_association: *69 _links: type: object properties: - self: *245 - html: *245 - pull_request: *245 + self: *251 + html: *251 + pull_request: *251 required: - self - html @@ -89016,7 +89057,7 @@ paths: type: string body_html: type: string - reactions: *66 + reactions: *70 side: description: The side of the first line of the range for a multi-line comment. @@ -89136,7 +89177,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -89165,10 +89206,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 requestBody: required: true content: @@ -89197,7 +89238,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: default: value: @@ -89260,10 +89301,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 requestBody: required: true content: @@ -89298,9 +89339,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: *555 + default: *559 '404': *6 '422': *7 '403': *27 @@ -89322,9 +89363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -89388,8 +89429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *311 - - *312 + - *316 + - *317 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -89402,9 +89443,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *560 examples: - default: &557 + default: &561 value: type: file encoding: base64 @@ -89446,8 +89487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *311 - - *312 + - *316 + - *317 - name: dir description: The alternate path to look for a README file in: path @@ -89467,9 +89508,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *560 examples: - default: *557 + default: *561 '404': *6 '422': *15 x-github: @@ -89491,8 +89532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -89502,7 +89543,7 @@ paths: application/json: schema: type: array - items: &558 + items: &562 title: Release description: A release. type: object @@ -89584,7 +89625,7 @@ paths: author: *4 assets: type: array - items: &559 + items: &563 title: Release Asset description: Data related to a release. type: object @@ -89659,7 +89700,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *66 + reactions: *70 required: - assets_url - upload_url @@ -89751,7 +89792,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -89771,8 +89812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -89848,9 +89889,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: &562 + default: &566 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -89955,9 +89996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *311 - - *312 - - &560 + - *316 + - *317 + - &564 name: asset_id description: The unique identifier of the asset. in: path @@ -89969,9 +90010,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *563 examples: - default: &561 + default: &565 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 @@ -90006,7 +90047,7 @@ paths: type: User site_admin: false '404': *6 - '302': *452 + '302': *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90022,9 +90063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *311 - - *312 - - *560 + - *316 + - *317 + - *564 requestBody: required: false content: @@ -90053,9 +90094,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *563 examples: - default: *561 + default: *565 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90071,9 +90112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *311 - - *312 - - *560 + - *316 + - *317 + - *564 responses: '204': description: Response @@ -90097,8 +90138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -90184,16 +90225,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: *562 + default: *566 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90210,8 +90251,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *311 - - *312 + - *316 + - *317 - name: tag description: tag parameter in: path @@ -90224,9 +90265,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: *562 + default: *566 '404': *6 x-github: githubCloudOnly: false @@ -90248,9 +90289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *311 - - *312 - - &563 + - *316 + - *317 + - &567 name: release_id description: The unique identifier of the release. in: path @@ -90264,9 +90305,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: *562 examples: - default: *562 + default: *566 '401': description: Unauthorized x-github: @@ -90284,9 +90325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 requestBody: required: false content: @@ -90350,9 +90391,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: *562 + default: *566 '404': description: Not Found if the discussion category name is invalid content: @@ -90373,9 +90414,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 responses: '204': description: Response @@ -90395,9 +90436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 - *17 - *19 responses: @@ -90407,7 +90448,7 @@ paths: application/json: schema: type: array - items: *559 + items: *563 examples: default: value: @@ -90444,7 +90485,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90488,9 +90529,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: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 - name: name in: query required: true @@ -90516,7 +90557,7 @@ paths: description: Response for successful upload content: application/json: - schema: *559 + schema: *563 examples: response-for-successful-upload: value: @@ -90571,9 +90612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 - 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. @@ -90597,11 +90638,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -90620,9 +90661,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 requestBody: required: true content: @@ -90652,16 +90693,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -90683,10 +90724,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *311 - - *312 - - *563 - - *307 + - *316 + - *317 + - *567 + - *314 responses: '204': description: Response @@ -90710,9 +90751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 - *17 - *19 responses: @@ -90728,8 +90769,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *263 - - &564 + - *269 + - &568 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90748,69 +90789,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *264 - - *564 - - allOf: - - *265 - - *564 - - allOf: - - *266 - - *564 - - allOf: - - *565 - - *564 - - allOf: - - *267 - - *564 - - allOf: - - *268 - - *564 - - allOf: - - *269 - - *564 - allOf: - *270 - - *564 + - *568 - allOf: - *271 - - *564 + - *568 - allOf: - *272 - - *564 + - *568 + - allOf: + - *569 + - *568 - allOf: - *273 - - *564 + - *568 - allOf: - *274 - - *564 + - *568 - allOf: - *275 - - *564 + - *568 - allOf: - *276 - - *564 + - *568 - allOf: - *277 - - *564 + - *568 - allOf: - *278 - - *564 + - *568 - allOf: - *279 - - *564 + - *568 - allOf: - *280 - - *564 + - *568 - allOf: - *281 - - *564 + - *568 - allOf: - *282 - - *564 + - *568 + - allOf: + - *283 + - *568 + - allOf: + - *284 + - *568 + - allOf: + - *285 + - *568 - allOf: - - *566 - - *564 + - *286 + - *568 + - allOf: + - *287 + - *568 + - allOf: + - *288 + - *568 + - allOf: + - *289 + - *568 examples: default: value: @@ -90849,8 +90890,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - name: includes_parents @@ -90861,7 +90902,7 @@ paths: schema: type: boolean default: true - - *567 + - *570 responses: '200': description: Response @@ -90869,7 +90910,7 @@ paths: application/json: schema: type: array - items: *283 + items: *290 examples: default: value: @@ -90900,7 +90941,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -90916,8 +90957,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 requestBody: description: Request body required: true @@ -90937,16 +90978,16 @@ paths: - tag - push default: branch - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *258 + items: *267 + conditions: *264 rules: type: array description: An array of rules within the ruleset. - items: *568 + items: *571 required: - name - enforcement @@ -90977,9 +91018,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: &578 + default: &581 value: id: 42 name: super cool ruleset @@ -91012,7 +91053,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -91026,12 +91067,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *311 - - *312 - - *569 - - *570 - - *571 + - *316 + - *317 - *572 + - *573 + - *574 + - *575 - *17 - *19 responses: @@ -91039,11 +91080,11 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *574 + default: *577 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91062,19 +91103,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *311 - - *312 - - *575 + - *316 + - *317 + - *578 responses: '200': description: Response content: application/json: - schema: *576 + schema: *579 examples: - default: *577 + default: *580 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91100,8 +91141,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91121,11 +91162,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *578 + default: *581 '404': *6 - '500': *96 + '500': *102 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -91141,8 +91182,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91167,16 +91208,16 @@ paths: - branch - tag - push - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *258 + items: *267 + conditions: *264 rules: description: An array of rules within the ruleset. type: array - items: *568 + items: *571 examples: default: value: @@ -91204,11 +91245,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *578 + default: *581 '404': *6 - '500': *96 + '500': *102 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -91224,8 +91265,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91236,7 +91277,7 @@ paths: '204': description: Response '404': *6 - '500': *96 + '500': *102 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -91248,8 +91289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - name: ruleset_id @@ -91265,11 +91306,11 @@ paths: application/json: schema: type: array - items: *286 + items: *293 examples: - default: *579 + default: *582 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91286,8 +91327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91305,7 +91346,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *583 examples: default: value: @@ -91338,7 +91379,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91360,21 +91401,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *311 - - *312 - - *581 - - *582 - - *583 + - *316 + - *317 - *584 - - *46 - - *19 - - *17 - *585 - *586 - *587 - *588 + - *50 + - *19 + - *17 - *589 - *590 + - *591 + - *592 + - *593 + - *594 responses: '200': description: Response @@ -91382,24 +91424,24 @@ paths: application/json: schema: type: array - items: &594 + items: &598 type: object properties: - number: *154 - created_at: *155 + number: *160 + created_at: *161 updated_at: anyOf: - type: 'null' - - *156 - url: *157 - html_url: *158 + - *162 + url: *163 + html_url: *164 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *591 - resolution: *592 + state: *595 + resolution: *596 resolved_at: type: - string @@ -91493,7 +91535,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *593 + - *597 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91616,7 +91658,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91638,16 +91680,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *311 - - *312 - - *410 - - *590 + - *316 + - *317 + - *414 + - *594 responses: '200': description: Response content: application/json: - schema: *594 + schema: *598 examples: default: value: @@ -91678,7 +91720,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91689,6 +91731,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -91699,9 +91743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 requestBody: required: true content: @@ -91709,28 +91753,44 @@ paths: schema: type: object properties: - state: *591 - resolution: *592 + state: *595 + resolution: *596 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: + - string + - 'null' anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *594 + schema: *598 examples: default: value: @@ -91775,6 +91835,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + 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 '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -91782,8 +91861,9 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment - '503': *97 + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -91805,9 +91885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 - *19 - *17 responses: @@ -91818,7 +91898,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &740 + items: &751 type: object properties: type: @@ -91845,10 +91925,6 @@ paths: - commit details: oneOf: - - *595 - - *596 - - *597 - - *598 - *599 - *600 - *601 @@ -91858,6 +91934,10 @@ paths: - *605 - *606 - *607 + - *608 + - *609 + - *610 + - *611 examples: default: value: @@ -91917,11 +91997,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *52 + Link: *56 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91943,8 +92023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -91952,14 +92032,14 @@ paths: schema: type: object properties: - reason: &609 + reason: &613 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *608 + placeholder_id: *612 required: - reason - placeholder_id @@ -91976,7 +92056,7 @@ paths: schema: type: object properties: - reason: *609 + reason: *613 expire_at: type: - string @@ -92000,7 +92080,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -92023,13 +92103,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: - - *311 - - *312 + - *316 + - *317 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *97 + '503': *103 '200': description: Response content: @@ -92039,7 +92119,7 @@ paths: properties: incremental_scans: type: array - items: &610 + items: &614 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92067,15 +92147,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *610 + items: *614 backfill_scans: type: array - items: *610 + items: *614 custom_pattern_backfill_scans: type: array items: allOf: - - *610 + - *614 - type: object properties: pattern_name: @@ -92145,9 +92225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *311 - - *312 - - *46 + - *316 + - *317 + - *50 - name: sort description: The property to sort the results by. in: query @@ -92159,8 +92239,8 @@ paths: - updated - published default: created - - *38 - - *39 + - *43 + - *44 - 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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -92190,9 +92270,9 @@ paths: application/json: schema: type: array - items: *611 + items: *615 examples: - default: *612 + default: *616 '400': *14 '404': *6 x-github: @@ -92215,8 +92295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -92296,7 +92376,7 @@ paths: login: type: string description: The username of the user credited. - type: *289 + type: *296 required: - login - type @@ -92386,9 +92466,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *615 examples: - default: &614 + default: &618 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92621,8 +92701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -92735,7 +92815,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *615 examples: default: value: @@ -92882,17 +92962,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 responses: '200': description: Response content: application/json: - schema: *611 + schema: *615 examples: - default: *614 + default: *618 '403': *27 '404': *6 x-github: @@ -92916,9 +92996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 requestBody: required: true content: @@ -92998,7 +93078,7 @@ paths: login: type: string description: The username of the user credited. - type: *289 + type: *296 required: - login - type @@ -93089,17 +93169,17 @@ paths: description: Response content: application/json: - schema: *611 + schema: *615 examples: - default: *614 - add_credit: *614 + default: *618 + add_credit: *618 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *105 + schema: *111 examples: invalid_state_transition: value: @@ -93130,9 +93210,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: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 responses: '202': *37 '400': *14 @@ -93159,17 +93239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 responses: '202': description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 '400': *14 '422': *15 '403': *27 @@ -93195,8 +93275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -93270,7 +93350,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -93292,8 +93372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -93302,7 +93382,7 @@ paths: application/json: schema: type: array - items: &615 + items: &619 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93315,7 +93395,7 @@ paths: - 1124 - -435 '202': *37 - '204': *168 + '204': *174 '422': description: Repository contains more than 10,000 commits x-github: @@ -93335,8 +93415,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -93387,7 +93467,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93414,8 +93494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -93487,7 +93567,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93509,8 +93589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -93664,8 +93744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -93675,7 +93755,7 @@ paths: application/json: schema: type: array - items: *615 + items: *619 examples: default: value: @@ -93688,7 +93768,7 @@ paths: - - 0 - 2 - 21 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93708,8 +93788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *311 - - *312 + - *316 + - *317 - name: sha in: path required: true @@ -93765,7 +93845,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *620 examples: default: value: @@ -93819,8 +93899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -93832,9 +93912,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93852,14 +93932,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &617 + schema: &621 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93932,8 +94012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -93959,7 +94039,7 @@ paths: description: Response content: application/json: - schema: *617 + schema: *621 examples: default: value: @@ -93986,8 +94066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -94007,8 +94087,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -94067,7 +94147,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94090,8 +94170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -94099,7 +94179,7 @@ paths: application/json: schema: type: array - items: &618 + items: &622 title: Tag protection description: Tag protection type: object @@ -94156,8 +94236,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -94180,7 +94260,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *622 examples: default: value: @@ -94211,8 +94291,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: - - *311 - - *312 + - *316 + - *317 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -94249,8 +94329,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *311 - - *312 + - *316 + - *317 - name: ref in: path required: true @@ -94286,8 +94366,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -94297,11 +94377,11 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -94319,8 +94399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *311 - - *312 + - *316 + - *317 - *19 - *17 responses: @@ -94328,7 +94408,7 @@ paths: description: Response content: application/json: - schema: &619 + schema: &623 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94340,7 +94420,7 @@ paths: required: - names examples: - default: &620 + default: &624 value: names: - octocat @@ -94363,8 +94443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -94395,9 +94475,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *623 examples: - default: *620 + default: *624 '404': *6 '422': *7 x-github: @@ -94418,9 +94498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *311 - - *312 - - &621 + - *316 + - *317 + - &625 name: per description: The time frame to display results for. in: query @@ -94451,7 +94531,7 @@ paths: - 128 clones: type: array - items: &622 + items: &626 title: Traffic type: object properties: @@ -94538,8 +94618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -94633,8 +94713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -94697,9 +94777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *311 - - *312 - - *621 + - *316 + - *317 + - *625 responses: '200': description: Response @@ -94720,7 +94800,7 @@ paths: - 3782 views: type: array - items: *622 + items: *626 required: - uniques - count @@ -94797,8 +94877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -94834,7 +94914,7 @@ paths: description: Response content: application/json: - schema: *136 + schema: *142 examples: default: value: @@ -95072,8 +95152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -95096,8 +95176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -95119,8 +95199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -95146,8 +95226,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *311 - - *312 + - *316 + - *317 - name: ref in: path required: true @@ -95239,9 +95319,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95282,7 +95362,7 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: default: value: @@ -95471,7 +95551,7 @@ paths: html_url: type: string format: uri - repository: *136 + repository: *142 score: type: number file_size: @@ -95490,7 +95570,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &623 + text_matches: &627 title: Search Result Text Matches type: array items: @@ -95605,7 +95685,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *97 + '503': *103 '422': *15 '403': *27 x-github: @@ -95653,7 +95733,7 @@ paths: enum: - author-date - committer-date - - &624 + - &628 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 @@ -95722,7 +95802,7 @@ paths: committer: anyOf: - type: 'null' - - *377 + - *381 comment_count: type: integer message: @@ -95741,7 +95821,7 @@ paths: url: type: string format: uri - verification: *488 + verification: *492 required: - author - committer @@ -95756,7 +95836,7 @@ paths: committer: anyOf: - type: 'null' - - *377 + - *381 parents: type: array items: @@ -95768,12 +95848,12 @@ paths: type: string sha: type: string - repository: *136 + repository: *142 score: type: number node_id: type: string - text_matches: *623 + text_matches: *627 required: - sha - node_id @@ -95965,7 +96045,7 @@ paths: - interactions - created - updated - - *624 + - *628 - *17 - *19 - name: advanced_search @@ -96062,11 +96142,11 @@ paths: type: - string - 'null' - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: type: string state_reason: @@ -96080,7 +96160,7 @@ paths: milestone: anyOf: - type: 'null' - - *244 + - *250 comments: type: integer created_at: @@ -96094,7 +96174,7 @@ paths: - string - 'null' format: date-time - text_matches: *623 + text_matches: *627 pull_request: type: object properties: @@ -96132,10 +96212,10 @@ paths: type: string score: type: number - author_association: *65 + author_association: *69 draft: type: boolean - repository: *64 + repository: *68 body_html: type: string body_text: @@ -96143,12 +96223,12 @@ paths: timeline_url: type: string format: uri - type: *208 + type: *214 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *66 + reactions: *70 required: - assignee - closed_at @@ -96264,7 +96344,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *97 + '503': *103 '422': *15 '304': *35 '403': *27 @@ -96317,7 +96397,7 @@ paths: enum: - created - updated - - *624 + - *628 - *17 - *19 responses: @@ -96362,7 +96442,7 @@ paths: - 'null' score: type: number - text_matches: *623 + text_matches: *627 required: - id - node_id @@ -96447,7 +96527,7 @@ paths: - forks - help-wanted-issues - updated - - *624 + - *628 - *17 - *19 responses: @@ -96666,7 +96746,7 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 permissions: type: object properties: @@ -96684,7 +96764,7 @@ paths: - admin - pull - push - text_matches: *623 + text_matches: *627 temp_clone_token: type: string allow_merge_commit: @@ -96887,7 +96967,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *97 + '503': *103 '422': *15 '304': *35 x-github: @@ -96992,7 +97072,7 @@ paths: - string - 'null' format: uri - text_matches: *623 + text_matches: *627 related: type: - array @@ -97185,7 +97265,7 @@ paths: - followers - repositories - joined - - *624 + - *628 - *17 - *19 responses: @@ -97295,7 +97375,7 @@ paths: type: - boolean - 'null' - text_matches: *623 + text_matches: *627 blog: type: - string @@ -97357,7 +97437,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *97 + '503': *103 '422': *15 x-github: githubCloudOnly: false @@ -97377,7 +97457,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &628 + - &632 name: team_id description: The unique identifier of the team. in: path @@ -97389,9 +97469,9 @@ paths: description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -97418,7 +97498,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *628 + - *632 requestBody: required: true content: @@ -97482,16 +97562,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '201': description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 '422': *15 '403': *27 @@ -97519,7 +97599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *628 + - *632 responses: '204': description: Response @@ -97550,8 +97630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *628 - - *46 + - *632 + - *50 - *17 - *19 responses: @@ -97561,11 +97641,11 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *629 + default: *633 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97592,7 +97672,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *628 + - *632 requestBody: required: true content: @@ -97626,9 +97706,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: triggersNotification: true githubCloudOnly: false @@ -97655,16 +97735,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97689,8 +97769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 requestBody: required: false content: @@ -97713,9 +97793,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *630 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97740,8 +97820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 responses: '204': description: Response @@ -97770,9 +97850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *628 - - *300 - - *46 + - *632 + - *307 + - *50 - *17 - *19 responses: @@ -97782,11 +97862,11 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *631 + default: *635 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97813,8 +97893,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *628 - - *300 + - *632 + - *307 requestBody: required: true content: @@ -97836,9 +97916,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: triggersNotification: true githubCloudOnly: false @@ -97865,17 +97945,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 responses: '200': description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97900,9 +97980,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 requestBody: required: true content: @@ -97924,9 +98004,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *632 + default: *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97951,9 +98031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 responses: '204': description: Response @@ -97982,9 +98062,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 - 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. @@ -98010,11 +98090,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98041,9 +98121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 requestBody: required: true content: @@ -98075,9 +98155,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98103,8 +98183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 - 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. @@ -98130,11 +98210,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98161,8 +98241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 requestBody: required: true content: @@ -98194,9 +98274,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98220,7 +98300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *628 + - *632 - *17 - *19 responses: @@ -98230,11 +98310,11 @@ paths: application/json: schema: type: array - items: *205 + items: *211 examples: - default: *206 + default: *212 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98258,7 +98338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *628 + - *632 - name: role description: Filters members returned by their role in the team. in: query @@ -98281,9 +98361,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -98309,8 +98389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: if user is a member @@ -98346,8 +98426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: Response @@ -98386,8 +98466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: Response @@ -98423,16 +98503,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '200': description: Response content: application/json: - schema: *308 + schema: *315 examples: - response-if-user-is-a-team-maintainer: *633 + response-if-user-is-a-team-maintainer: *637 '404': *6 x-github: githubCloudOnly: false @@ -98465,8 +98545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *628 - - *57 + - *632 + - *61 requestBody: required: false content: @@ -98491,9 +98571,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - response-if-users-membership-with-team-is-now-pending: *634 + response-if-users-membership-with-team-is-now-pending: *638 '403': description: Forbidden if team synchronization is set up '422': @@ -98527,8 +98607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: Response @@ -98542,174 +98622,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - *628 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *309 - examples: - default: *635 - headers: - Link: *52 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *628 - - *310 - responses: - '200': - description: Response - content: - application/json: - schema: *309 - examples: - default: *636 - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *628 - - *310 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *628 - - *310 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -98723,7 +98635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *628 + - *632 - *17 - *19 responses: @@ -98733,11 +98645,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -98765,15 +98677,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *628 - - *311 - - *312 + - *632 + - *316 + - *317 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *637 + schema: *639 examples: alternative-response-with-extra-repository-information: value: @@ -98924,9 +98836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *628 - - *311 - - *312 + - *632 + - *316 + - *317 requestBody: required: false content: @@ -98976,9 +98888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *628 - - *311 - - *312 + - *632 + - *316 + - *317 responses: '204': description: Response @@ -99003,7 +98915,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *628 + - *632 - *17 - *19 responses: @@ -99013,11 +98925,11 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - response-if-child-teams-exist: *638 + response-if-child-teams-exist: *640 headers: - Link: *52 + Link: *56 '404': *6 '403': *27 '422': *15 @@ -99048,7 +98960,7 @@ paths: application/json: schema: oneOf: - - &640 + - &642 title: Private User description: Private User type: object @@ -99298,7 +99210,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *639 + - *641 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99458,7 +99370,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *642 examples: default: value: @@ -99537,7 +99449,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '304': *35 '404': *6 '403': *27 @@ -99560,7 +99472,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: - - *57 + - *61 responses: '204': description: If the user is blocked @@ -99588,7 +99500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -99612,7 +99524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -99661,11 +99573,11 @@ paths: type: integer codespaces: type: array - items: *213 + items: *219 examples: - default: *214 + default: *220 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -99802,21 +99714,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '401': *23 '403': *27 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99856,7 +99768,7 @@ paths: type: integer secrets: type: array - items: &641 + items: &643 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99898,9 +99810,9 @@ paths: - visibility - selected_repositories_url examples: - default: *432 + default: *436 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99970,13 +99882,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *144 + - *150 responses: '200': description: Response content: application/json: - schema: *641 + schema: *643 examples: default: value: @@ -100006,7 +99918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *144 + - *150 requestBody: required: true content: @@ -100051,7 +99963,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -100079,7 +99991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *144 + - *150 responses: '204': description: Response @@ -100104,7 +100016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *144 + - *150 responses: '200': description: Response @@ -100120,13 +100032,13 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *642 + default: *644 '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100147,7 +100059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *144 + - *150 requestBody: required: true content: @@ -100179,7 +100091,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100201,7 +100113,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *144 + - *150 - name: repository_id in: path required: true @@ -100213,7 +100125,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100234,7 +100146,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *144 + - *150 - name: repository_id in: path required: true @@ -100246,7 +100158,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100266,17 +100178,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100300,7 +100212,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 requestBody: required: false content: @@ -100330,9 +100242,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '401': *23 '403': *27 '404': *6 @@ -100354,11 +100266,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '202': *37 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100383,13 +100295,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '202': description: Response content: application/json: - schema: &643 + schema: &645 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100442,7 +100354,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &644 + default: &646 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100450,7 +100362,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100474,7 +100386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *215 + - *221 - name: export_id in: path required: true @@ -100487,9 +100399,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: - default: *644 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -100510,7 +100422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *215 + - *221 responses: '200': description: Response @@ -100526,11 +100438,11 @@ paths: type: integer machines: type: array - items: *431 + items: *435 examples: - default: *645 + default: *647 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100557,7 +100469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *215 + - *221 requestBody: required: true content: @@ -100613,11 +100525,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *317 + repository: *319 machine: anyOf: - type: 'null' - - *431 + - *435 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -101414,17 +101326,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '304': *35 - '500': *96 + '500': *102 '400': *14 '401': *23 '402': @@ -101434,7 +101346,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101454,16 +101366,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 - '500': *96 + default: *434 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -101492,9 +101404,9 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: &656 + default: &658 value: - id: 197 name: hello_docker @@ -101595,7 +101507,7 @@ paths: application/json: schema: type: array - items: &646 + items: &648 title: Email description: Email type: object @@ -101665,16 +101577,16 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: &658 + default: &660 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -101744,7 +101656,7 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: default: value: @@ -101856,9 +101768,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -101889,9 +101801,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -101911,7 +101823,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: - - *57 + - *61 responses: '204': description: if the person is followed by the authenticated user @@ -101941,7 +101853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -101966,7 +101878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -102002,7 +101914,7 @@ paths: application/json: schema: type: array - items: &647 + items: &649 title: GPG Key description: A unique encryption key type: object @@ -102147,7 +102059,7 @@ paths: - subkeys - revoked examples: - default: &672 + default: &674 value: - id: 3 name: Octocat's GPG Key @@ -102179,7 +102091,7 @@ paths: revoked: false raw_key: string headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -102232,9 +102144,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *649 examples: - default: &648 + default: &650 value: id: 3 name: Octocat's GPG Key @@ -102291,7 +102203,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &649 + - &651 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102303,9 +102215,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *649 examples: - default: *648 + default: *650 '404': *6 '304': *35 '403': *27 @@ -102328,7 +102240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *649 + - *651 responses: '204': description: Response @@ -102471,7 +102383,7 @@ paths: suspended_at: suspended_by: headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -102517,11 +102429,11 @@ paths: type: string repositories: type: array - items: *64 + items: *68 examples: - default: *128 + default: *134 headers: - Link: *52 + Link: *56 '404': *6 '403': *27 '304': *35 @@ -102544,7 +102456,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *125 + - *131 responses: '204': description: Response @@ -102570,7 +102482,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *125 + - *131 responses: '204': description: Response @@ -102604,12 +102516,12 @@ paths: application/json: schema: anyOf: - - *203 + - *209 - type: object properties: {} additionalProperties: false examples: - default: *204 + default: *210 '204': description: Response when there are no restrictions x-github: @@ -102633,7 +102545,7 @@ paths: required: true content: application/json: - schema: *499 + schema: *503 examples: default: value: @@ -102644,7 +102556,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *209 examples: default: value: @@ -102725,7 +102637,7 @@ paths: - closed - all default: open - - *211 + - *217 - name: sort description: What to sort results by. in: query @@ -102737,8 +102649,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - *17 - *19 responses: @@ -102748,11 +102660,11 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *212 + default: *218 headers: - Link: *52 + Link: *56 '404': *6 '304': *35 x-github: @@ -102783,7 +102695,7 @@ paths: application/json: schema: type: array - items: &650 + items: &652 title: Key description: Key type: object @@ -102835,7 +102747,7 @@ paths: verified: false read_only: false headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -102886,9 +102798,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *652 examples: - default: &651 + default: &653 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102921,15 +102833,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *531 responses: '200': description: Response content: application/json: - schema: *650 + schema: *652 examples: - default: *651 + default: *653 '404': *6 '304': *35 '403': *27 @@ -102952,7 +102864,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *531 responses: '204': description: Response @@ -102985,7 +102897,7 @@ paths: application/json: schema: type: array - items: &652 + items: &654 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103053,7 +102965,7 @@ paths: - id - type - login - plan: *81 + plan: *85 required: - billing_cycle - next_billing_date @@ -103064,7 +102976,7 @@ paths: - account - plan examples: - default: &653 + default: &655 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103097,7 +103009,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *52 + Link: *56 '304': *35 '401': *23 '404': *6 @@ -103126,11 +103038,11 @@ paths: application/json: schema: type: array - items: *652 + items: *654 examples: - default: *653 + default: *655 headers: - Link: *52 + Link: *56 '304': *35 '401': *23 x-github: @@ -103168,7 +103080,7 @@ paths: application/json: schema: type: array - items: *217 + items: *223 examples: default: value: @@ -103245,7 +103157,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -103270,13 +103182,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *217 + schema: *223 examples: default: value: @@ -103334,7 +103246,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *61 + - *65 requestBody: required: true content: @@ -103359,7 +103271,7 @@ paths: description: Response content: application/json: - schema: *217 + schema: *223 examples: default: value: @@ -103427,7 +103339,7 @@ paths: application/json: schema: type: array - items: *219 + items: *225 examples: default: value: @@ -103580,7 +103492,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -103689,7 +103601,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -103869,7 +103781,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *220 + - *226 - name: exclude in: query required: false @@ -103882,7 +103794,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -104076,7 +103988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *220 + - *226 responses: '302': description: Response @@ -104102,7 +104014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *220 + - *226 responses: '204': description: Response @@ -104131,8 +104043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *220 - - *654 + - *226 + - *656 responses: '204': description: Response @@ -104156,7 +104068,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *220 + - *226 - *17 - *19 responses: @@ -104166,11 +104078,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -104203,11 +104115,11 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: *94 + default: *98 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -104247,7 +104159,7 @@ paths: - docker - nuget - container - - *655 + - *657 - *19 - *17 responses: @@ -104257,10 +104169,10 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *656 - '400': *657 + default: *658 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104280,16 +104192,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *227 - - *228 + - *233 + - *234 responses: '200': description: Response content: application/json: - schema: *225 + schema: *231 examples: - default: &673 + default: &675 value: id: 40201 name: octo-name @@ -104402,8 +104314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *227 - - *228 + - *233 + - *234 responses: '204': description: Response @@ -104433,8 +104345,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *227 - - *228 + - *233 + - *234 - name: token description: package token schema: @@ -104466,8 +104378,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: - - *227 - - *228 + - *233 + - *234 - *19 - *17 - name: state @@ -104487,7 +104399,7 @@ paths: application/json: schema: type: array - items: *229 + items: *235 examples: default: value: @@ -104536,15 +104448,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *227 - - *228 - - *230 + - *233 + - *234 + - *236 responses: '200': description: Response content: application/json: - schema: *229 + schema: *235 examples: default: value: @@ -104580,9 +104492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *227 - - *228 - - *230 + - *233 + - *234 + - *236 responses: '204': description: Response @@ -104612,9 +104524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *227 - - *228 - - *230 + - *233 + - *234 + - *236 responses: '204': description: Response @@ -104651,11 +104563,11 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: *658 + default: *660 headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -104764,9 +104676,9 @@ paths: application/json: schema: type: array - items: *64 + items: *68 examples: - default: &665 + default: &667 summary: Default response value: - id: 1296269 @@ -104887,7 +104799,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *52 + Link: *56 '422': *15 '304': *35 '403': *27 @@ -105084,9 +104996,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105124,11 +105036,11 @@ paths: application/json: schema: type: array - items: *501 + items: *505 examples: - default: *659 + default: *661 headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105149,12 +105061,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *207 + - *213 responses: '204': description: Response '403': *27 - '409': *45 + '409': *49 '404': *6 '304': *35 x-github: @@ -105172,11 +105084,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *207 + - *213 responses: '204': description: Response - '409': *45 + '409': *49 '304': *35 '404': *6 '403': *27 @@ -105205,7 +105117,7 @@ paths: application/json: schema: type: array - items: &660 + items: &662 title: Social account description: Social media account type: object @@ -105222,12 +105134,12 @@ paths: - provider - url examples: - default: &661 + default: &663 value: - provider: twitter url: https://twitter.com/github headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105285,9 +105197,9 @@ paths: application/json: schema: type: array - items: *660 + items: *662 examples: - default: *661 + default: *663 '422': *15 '304': *35 '404': *6 @@ -105375,7 +105287,7 @@ paths: application/json: schema: type: array - items: &662 + items: &664 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105395,7 +105307,7 @@ paths: - title - created_at examples: - default: &681 + default: &692 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105406,7 +105318,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105460,9 +105372,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: &663 + default: &665 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105492,7 +105404,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: - - &664 + - &666 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105504,9 +105416,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: *663 + default: *665 '404': *6 '304': *35 '403': *27 @@ -105529,7 +105441,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: - - *664 + - *666 responses: '204': description: Response @@ -105558,7 +105470,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &682 + - &693 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 @@ -105571,7 +105483,7 @@ paths: - created - updated default: created - - *46 + - *50 - *17 - *19 responses: @@ -105581,13 +105493,13 @@ paths: application/json: schema: type: array - items: *64 + items: *68 examples: - default-response: *665 + default-response: *667 application/vnd.github.v3.star+json: schema: type: array - items: &683 + items: &694 title: Starred Repository description: Starred Repository type: object @@ -105595,7 +105507,7 @@ paths: starred_at: type: string format: date-time - repo: *64 + repo: *68 required: - starred_at - repo @@ -105723,7 +105635,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -105743,8 +105655,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: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response if this repository is starred by you @@ -105772,8 +105684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -105797,8 +105709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -105831,11 +105743,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -105870,7 +105782,7 @@ paths: application/json: schema: type: array - items: *296 + items: *303 examples: default: value: @@ -105921,7 +105833,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105948,7 +105860,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *83 + - *87 responses: '200': description: Response @@ -105956,10 +105868,10 @@ paths: application/json: schema: oneOf: - - *640 - - *639 + - *642 + - *641 examples: - default-response: &667 + default-response: &669 summary: Default response value: login: octocat @@ -105994,7 +105906,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &668 + response-with-git-hub-plan-information: &670 summary: Response with GitHub plan information value: login: octocat @@ -106057,7 +105969,7 @@ paths: required: true schema: type: string - - *243 + - *249 requestBody: required: true description: Details of the draft item to create in the project. @@ -106091,9 +106003,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *254 examples: - draft_issue: *249 + draft_issue: *255 '304': *35 '403': *27 '401': *23 @@ -106116,7 +106028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *666 + - *668 - *17 responses: '200': @@ -106127,7 +106039,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: Link: example: ; rel="next" @@ -106157,7 +106069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *57 + - *61 responses: '200': description: Response @@ -106165,11 +106077,11 @@ paths: application/json: schema: oneOf: - - *640 - - *639 + - *642 + - *641 examples: - default-response: *667 - response-with-git-hub-plan-information: *668 + default-response: *669 + response-with-git-hub-plan-information: *670 '404': *6 x-github: githubCloudOnly: false @@ -106193,9 +106105,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *38 - - *39 - - *57 + - *43 + - *44 + - *61 requestBody: required: true content: @@ -106219,8 +106131,8 @@ paths: required: - subject_digests examples: - default: *669 - withPredicateType: *670 + default: *671 + withPredicateType: *672 responses: '200': description: Response @@ -106274,7 +106186,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *671 + default: *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106292,7 +106204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *57 + - *61 requestBody: required: true content: @@ -106357,7 +106269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *57 + - *61 - name: subject_digest description: Subject Digest in: path @@ -106388,7 +106300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *57 + - *61 - name: attestation_id description: Attestation ID in: path @@ -106424,9 +106336,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *17 - - *38 - - *39 - - *57 + - *43 + - *44 + - *61 - name: subject_digest description: Subject Digest in: path @@ -106479,12 +106391,12 @@ paths: initiator: type: string examples: - default: *373 + default: *377 '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -106510,7 +106422,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: - - *57 + - *61 responses: '200': description: Response @@ -106518,9 +106430,9 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *656 + default: *658 '403': *27 '401': *23 x-github: @@ -106543,7 +106455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106553,7 +106465,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -106615,8 +106527,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *57 - *61 + - *65 - *17 - *19 responses: @@ -106626,7 +106538,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -106703,7 +106615,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106713,7 +106625,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -106771,7 +106683,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106783,9 +106695,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106802,7 +106714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106814,9 +106726,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106833,7 +106745,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *57 + - *61 - name: target_user in: path required: true @@ -106860,8 +106772,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *57 - - *68 + - *61 + - *72 - *17 - *19 responses: @@ -106871,11 +106783,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *70 + default: *74 headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -106894,7 +106806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106904,11 +106816,11 @@ paths: application/json: schema: type: array - items: *647 + items: *649 examples: - default: *672 + default: *674 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106930,7 +106842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *57 + - *61 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -107002,7 +106914,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *57 + - *61 responses: '200': description: Response @@ -107010,7 +106922,7 @@ paths: application/json: schema: *20 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107028,7 +106940,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107064,7 +106976,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107084,7 +106996,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107094,11 +107006,11 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: *94 + default: *98 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107135,8 +107047,8 @@ paths: - docker - nuget - container - - *655 - - *57 + - *657 + - *61 - *19 - *17 responses: @@ -107146,12 +107058,12 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *656 + default: *658 '403': *27 '401': *23 - '400': *657 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107171,17 +107083,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 responses: '200': description: Response content: application/json: - schema: *225 + schema: *231 examples: - default: *673 + default: *675 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107202,9 +107114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 responses: '204': description: Response @@ -107236,9 +107148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 - name: token description: package token schema: @@ -107270,9 +107182,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: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 responses: '200': description: Response @@ -107280,7 +107192,7 @@ paths: application/json: schema: type: array - items: *229 + items: *235 examples: default: value: @@ -107338,16 +107250,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *227 - - *228 - - *230 - - *57 + - *233 + - *234 + - *236 + - *61 responses: '200': description: Response content: application/json: - schema: *229 + schema: *235 examples: default: value: @@ -107382,10 +107294,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *227 - - *228 - - *57 - - *230 + - *233 + - *234 + - *61 + - *236 responses: '204': description: Response @@ -107417,10 +107329,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *227 - - *228 - - *57 - - *230 + - *233 + - *234 + - *61 + - *236 responses: '204': description: Response @@ -107444,15 +107356,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *57 + - *61 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *38 - - *39 + - *43 + - *44 - *17 responses: '200': @@ -107461,11 +107373,11 @@ paths: application/json: schema: type: array - items: *241 + items: *247 examples: - default: *242 + default: *248 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107485,18 +107397,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *243 - - *57 + - *249 + - *61 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: - default: *242 + default: *248 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107516,11 +107428,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *243 - - *57 + - *249 + - *61 - *17 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -107528,11 +107440,11 @@ paths: application/json: schema: type: array - items: *246 + items: *252 examples: - default: *674 + default: *676 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107541,6 +107453,116 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - *61 + - *249 + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: *677 + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: *678 + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: *679 + iteration_field: *680 + responses: + '201': + description: Response + content: + application/json: + schema: *252 + examples: + text_field: *681 + number_field: *682 + date_field: *683 + single_select_field: *684 + iteration_field: *685 + '304': *35 + '403': *27 + '401': *23 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -107552,19 +107574,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *243 - - *675 - - *57 + - *249 + - *686 + - *61 responses: '200': description: Response content: application/json: - schema: *246 + schema: *252 examples: - default: *676 + default: *687 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107585,10 +107607,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *243 - - *57 - - *38 - - *39 + - *249 + - *61 + - *43 + - *44 - *17 - 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) @@ -107618,11 +107640,11 @@ paths: application/json: schema: type: array - items: *250 + items: *256 examples: - default: *251 + default: *257 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107641,8 +107663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *57 - - *243 + - *61 + - *249 requestBody: required: true description: Details of the item to add to the project. @@ -107679,10 +107701,10 @@ paths: description: Response content: application/json: - schema: *248 + schema: *254 examples: - issue: *249 - pull_request: *249 + issue: *255 + pull_request: *255 '304': *35 '403': *27 '401': *23 @@ -107702,9 +107724,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *243 - - *57 - - *252 + - *249 + - *61 + - *258 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -107724,11 +107746,11 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - default: *251 + default: *257 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107747,9 +107769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *243 - - *57 - - *252 + - *249 + - *61 + - *258 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -107822,13 +107844,13 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - text_field: *251 - number_field: *251 - date_field: *251 - single_select_field: *251 - iteration_field: *251 + text_field: *257 + number_field: *257 + date_field: *257 + single_select_field: *257 + iteration_field: *257 '401': *23 '403': *27 '404': *6 @@ -107848,9 +107870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *243 - - *57 - - *252 + - *249 + - *61 + - *258 responses: '204': description: Response @@ -107877,7 +107899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107887,7 +107909,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -107952,7 +107974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107962,7 +107984,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -108025,7 +108047,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *57 + - *61 - name: type description: Limit results to repositories of the specified type. in: query @@ -108068,11 +108090,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108092,12 +108114,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *57 - - *99 - - *101 - - *100 - - *677 - - *102 + - *61 + - *105 + - *107 + - *106 + - *688 + - *108 responses: '200': description: Response when getting a billing premium request usage report @@ -108204,8 +108226,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108225,10 +108247,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *57 - - *99 - - *678 - - *100 + - *61 + - *105 + - *689 + - *106 responses: '200': description: Response when getting a billing usage report @@ -108298,8 +108320,8 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108322,13 +108344,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *57 - - *99 - - *101 - - *100 - - *679 - - *102 - - *680 + - *61 + - *105 + - *107 + - *106 + - *690 + - *108 + - *691 responses: '200': description: Response when getting a billing usage summary @@ -108433,8 +108455,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108452,7 +108474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -108462,11 +108484,11 @@ paths: application/json: schema: type: array - items: *660 + items: *662 examples: - default: *661 + default: *663 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108484,7 +108506,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -108494,11 +108516,11 @@ paths: application/json: schema: type: array - items: *662 + items: *664 examples: - default: *681 + default: *692 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108520,9 +108542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *57 - - *682 - - *46 + - *61 + - *693 + - *50 - *17 - *19 responses: @@ -108533,13 +108555,13 @@ paths: schema: anyOf: - type: array - items: *683 + items: *694 - type: array - items: *64 + items: *68 examples: - default-response: *665 + default-response: *667 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108556,7 +108578,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -108566,11 +108588,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108697,7 +108719,7 @@ webhooks: type: string enum: - disabled - enterprise: &684 + enterprise: &695 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108766,7 +108788,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &685 + installation: &696 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108787,7 +108809,7 @@ webhooks: required: - id - node_id - organization: &686 + organization: &697 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108860,7 +108882,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &687 + repository: &698 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -108889,7 +108911,7 @@ webhooks: license: anyOf: - type: 'null' - - *79 + - *83 organization: anyOf: - type: 'null' @@ -109773,10 +109795,10 @@ webhooks: type: string enum: - enabled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -109852,11 +109874,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: &688 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + rule: &699 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) @@ -110079,11 +110101,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + rule: *699 sender: *4 required: - action @@ -110271,11 +110293,11 @@ webhooks: - everyone required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + rule: *699 sender: *4 required: - action @@ -110359,7 +110381,7 @@ webhooks: type: string enum: - completed - check_run: &690 + check_run: &701 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110424,8 +110446,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *390 - repository: *136 + items: *394 + repository: *142 status: type: string enum: @@ -110469,7 +110491,7 @@ webhooks: - examples: - neutral - deployment: *689 + deployment: *700 details_url: type: string examples: @@ -110529,7 +110551,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *390 + items: *394 started_at: type: string format: date-time @@ -110567,10 +110589,10 @@ webhooks: - output - app - pull_requests - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 sender: *4 required: - check_run @@ -110963,11 +110985,11 @@ webhooks: type: string enum: - created - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *701 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 sender: *4 required: - check_run @@ -111363,11 +111385,11 @@ webhooks: type: string enum: - requested_action - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *701 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 requested_action: description: The action requested by the user. type: object @@ -111772,11 +111794,11 @@ webhooks: type: string enum: - rerequested - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *701 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 sender: *4 required: - check_run @@ -112768,10 +112790,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -113052,6 +113074,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113471,10 +113498,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -113750,6 +113777,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -114168,10 +114200,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -114340,7 +114372,7 @@ webhooks: required: - login - id - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114492,20 +114524,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &691 + commit_oid: &702 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: *684 - installation: *685 - organization: *686 - ref: &692 + enterprise: *695 + installation: *696 + organization: *697 + ref: &703 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: *687 + repository: *698 sender: *4 required: - action @@ -114672,7 +114704,7 @@ webhooks: required: - login - id - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114913,12 +114945,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -115016,7 +115048,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115201,12 +115233,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -115375,7 +115407,7 @@ webhooks: required: - login - id - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115552,12 +115584,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -115660,7 +115692,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115840,9 +115872,9 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115850,7 +115882,7 @@ webhooks: type: - string - 'null' - repository: *687 + repository: *698 sender: *4 required: - action @@ -115949,7 +115981,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116096,12 +116128,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -116363,10 +116395,10 @@ webhooks: - updated_at - author_association - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -116447,18 +116479,18 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *686 - pusher_type: &693 + organization: *697 + pusher_type: &704 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &694 + ref: &705 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116468,7 +116500,7 @@ webhooks: enum: - tag - branch - repository: *687 + repository: *698 sender: *4 required: - ref @@ -116550,10 +116582,10 @@ webhooks: type: string enum: - created - definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + definition: *259 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116638,9 +116670,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116717,10 +116749,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + definition: *259 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116797,10 +116829,10 @@ webhooks: type: string enum: - updated - definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + definition: *259 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116877,19 +116909,19 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - repository: *687 - organization: *686 + enterprise: *695 + installation: *696 + repository: *698 + organization: *697 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *95 + items: *101 old_property_values: type: array description: The old custom property values for the repository. - items: *95 + items: *101 required: - action - repository @@ -116965,18 +116997,18 @@ webhooks: title: delete event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - pusher_type: *693 - ref: *694 + enterprise: *695 + installation: *696 + organization: *697 + pusher_type: *704 + ref: *705 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *687 + repository: *698 sender: *4 required: - ref @@ -117060,11 +117092,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117148,11 +117180,11 @@ webhooks: type: string enum: - auto_reopened - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117236,11 +117268,11 @@ webhooks: type: string enum: - created - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117322,11 +117354,11 @@ webhooks: type: string enum: - dismissed - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117408,11 +117440,11 @@ webhooks: type: string enum: - fixed - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117495,11 +117527,11 @@ webhooks: type: string enum: - reintroduced - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117581,11 +117613,11 @@ webhooks: type: string enum: - reopened - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117662,9 +117694,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - key: &695 + enterprise: *695 + installation: *696 + key: &706 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117702,8 +117734,8 @@ webhooks: - verified - created_at - read_only - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -117780,11 +117812,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - key: *695 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + key: *706 + organization: *697 + repository: *698 sender: *4 required: - action @@ -118356,12 +118388,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: &699 + workflow: &710 title: Workflow type: - object @@ -119099,13 +119131,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *463 + deployment: *467 pull_requests: type: array - items: *547 - repository: *687 - organization: *686 - installation: *685 + items: *551 + repository: *698 + organization: *697 + installation: *696 sender: *4 responses: '200': @@ -119176,7 +119208,7 @@ webhooks: type: string enum: - approved - approver: &696 + approver: &707 type: object properties: avatar_url: @@ -119219,11 +119251,11 @@ webhooks: type: string comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: &697 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + reviewers: &708 type: array items: type: object @@ -119304,7 +119336,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &698 + workflow_job_run: &709 type: object properties: conclusion: @@ -120050,18 +120082,18 @@ webhooks: type: string enum: - rejected - approver: *696 + approver: *707 comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: *697 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + reviewers: *708 sender: *4 since: type: string - workflow_job_run: *698 + workflow_job_run: *709 workflow_job_runs: type: array items: @@ -120778,13 +120810,13 @@ webhooks: type: string enum: - requested - enterprise: *684 + enterprise: *695 environment: type: string - installation: *685 - organization: *686 - repository: *687 - requestor: &704 + installation: *696 + organization: *697 + repository: *698 + requestor: &715 title: User type: - object @@ -122727,12 +122759,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: *699 + workflow: *710 workflow_run: title: Deployment Workflow Run type: @@ -123423,7 +123455,7 @@ webhooks: type: string enum: - answered - answer: &702 + answer: &713 type: object properties: author_association: @@ -123583,7 +123615,7 @@ webhooks: - created_at - updated_at - body - discussion: &700 + discussion: &711 title: Discussion description: A Discussion in a repository. type: object @@ -123879,7 +123911,7 @@ webhooks: - id labels: type: array - items: *510 + items: *514 required: - repository_url - category @@ -123901,10 +123933,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124031,11 +124063,11 @@ webhooks: - from required: - category - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124118,11 +124150,11 @@ webhooks: type: string enum: - closed - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124204,7 +124236,7 @@ webhooks: type: string enum: - created - comment: &701 + comment: &712 type: object properties: author_association: @@ -124364,11 +124396,11 @@ webhooks: - updated_at - body - reactions - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124451,12 +124483,12 @@ webhooks: type: string enum: - deleted - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *712 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124551,12 +124583,12 @@ webhooks: - from required: - body - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *712 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124640,11 +124672,11 @@ webhooks: type: string enum: - created - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124726,11 +124758,11 @@ webhooks: type: string enum: - deleted - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124830,11 +124862,11 @@ webhooks: type: string required: - from - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124916,10 +124948,10 @@ webhooks: type: string enum: - labeled - discussion: *700 - enterprise: *684 - installation: *685 - label: &703 + discussion: *711 + enterprise: *695 + installation: *696 + label: &714 title: Label type: object properties: @@ -124952,8 +124984,8 @@ webhooks: - color - default - description - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125036,11 +125068,11 @@ webhooks: type: string enum: - locked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125122,11 +125154,11 @@ webhooks: type: string enum: - pinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125208,11 +125240,11 @@ webhooks: type: string enum: - reopened - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125297,16 +125329,16 @@ webhooks: changes: type: object properties: - new_discussion: *700 - new_repository: *687 + new_discussion: *711 + new_repository: *698 required: - new_discussion - new_repository - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125389,10 +125421,10 @@ webhooks: type: string enum: - unanswered - discussion: *700 - old_answer: *702 - organization: *686 - repository: *687 + discussion: *711 + old_answer: *713 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125474,12 +125506,12 @@ webhooks: type: string enum: - unlabeled - discussion: *700 - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125562,11 +125594,11 @@ webhooks: type: string enum: - unlocked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125648,11 +125680,11 @@ webhooks: type: string enum: - unpinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125725,7 +125757,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *684 + enterprise: *695 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126403,9 +126435,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - forkee @@ -126551,9 +126583,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pages: description: The pages that were updated. type: array @@ -126591,7 +126623,7 @@ webhooks: - action - sha - html_url - repository: *687 + repository: *698 sender: *4 required: - pages @@ -126667,10 +126699,10 @@ webhooks: type: string enum: - created - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: &705 + organization: *697 + repositories: &716 description: An array of repository objects that the installation can access. type: array @@ -126696,8 +126728,8 @@ webhooks: - name - full_name - private - repository: *687 - requester: *704 + repository: *698 + requester: *715 sender: *4 required: - action @@ -126772,11 +126804,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -126853,11 +126885,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -126934,10 +126966,10 @@ webhooks: type: string enum: - added - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories_added: &706 + organization: *697 + repositories_added: &717 description: An array of repository objects, which were added to the installation. type: array @@ -126983,15 +127015,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *687 - repository_selection: &707 + repository: *698 + repository_selection: &718 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *704 + requester: *715 sender: *4 required: - action @@ -127070,10 +127102,10 @@ webhooks: type: string enum: - removed - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories_added: *706 + organization: *697 + repositories_added: *717 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127100,9 +127132,9 @@ webhooks: - name - full_name - private - repository: *687 - repository_selection: *707 - requester: *704 + repository: *698 + repository_selection: *718 + requester: *715 sender: *4 required: - action @@ -127181,11 +127213,11 @@ webhooks: type: string enum: - suspend - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -127367,10 +127399,10 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 target_type: type: string @@ -127449,11 +127481,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -127701,8 +127733,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128519,8 +128551,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128537,7 +128569,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -128881,8 +128913,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -128962,7 +128994,7 @@ webhooks: type: string enum: - deleted - comment: &708 + comment: &719 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129129,8 +129161,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129943,8 +129975,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129961,7 +129993,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -130307,8 +130339,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -130388,7 +130420,7 @@ webhooks: type: string enum: - edited - changes: &732 + changes: &743 description: The changes to the comment. type: object properties: @@ -130400,9 +130432,9 @@ webhooks: type: string required: - from - comment: *708 - enterprise: *684 - installation: *685 + comment: *719 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131218,8 +131250,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131236,7 +131268,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -131580,8 +131612,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131665,15 +131697,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 + blocked_issue: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + blocking_issue_repo: *68 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131761,15 +131793,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 + blocked_issue: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + blocking_issue_repo: *68 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131856,15 +131888,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 - blocked_issue_repo: *64 + blocked_issue: *82 + blocked_issue_repo: *68 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131952,15 +131984,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 - blocked_issue_repo: *64 + blocked_issue: *82 + blocked_issue_repo: *68 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -132045,10 +132077,10 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - issue: &711 + assignee: *715 + enterprise: *695 + installation: *696 + issue: &722 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132860,11 +132892,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132881,7 +132913,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -132984,8 +133016,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -133065,8 +133097,8 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133883,11 +133915,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133904,7 +133936,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -134150,8 +134182,8 @@ webhooks: required: - state - closed_at - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -134230,8 +134262,8 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135039,11 +135071,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135060,7 +135092,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -135162,8 +135194,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -135242,8 +135274,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136074,11 +136106,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136095,7 +136127,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -136176,7 +136208,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &709 + milestone: &720 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136319,8 +136351,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -136419,8 +136451,8 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137232,11 +137264,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137250,7 +137282,7 @@ webhooks: timeline_url: type: string format: uri - type: *208 + type: *214 title: description: Title of the issue type: string @@ -137356,9 +137388,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -137438,8 +137470,8 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138250,11 +138282,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138268,7 +138300,7 @@ webhooks: timeline_url: type: string format: uri - type: *208 + type: *214 title: description: Title of the issue type: string @@ -138374,9 +138406,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -138456,8 +138488,8 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139293,11 +139325,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139311,7 +139343,7 @@ webhooks: timeline_url: type: string format: uri - type: *208 + type: *214 title: description: Title of the issue type: string @@ -139394,8 +139426,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -139474,8 +139506,8 @@ webhooks: type: string enum: - milestoned - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140305,11 +140337,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140326,7 +140358,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -140406,9 +140438,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *709 - organization: *686 - repository: *687 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -141300,11 +141332,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141400,7 +141432,7 @@ webhooks: required: - login - id - type: *208 + type: *214 required: - id - number @@ -141881,8 +141913,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142694,11 +142726,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142715,7 +142747,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -142817,8 +142849,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -142898,9 +142930,9 @@ webhooks: type: string enum: - pinned - enterprise: *684 - installation: *685 - issue: &710 + enterprise: *695 + installation: *696 + issue: &721 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143706,11 +143738,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143727,7 +143759,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -143829,8 +143861,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -143909,8 +143941,8 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144744,11 +144776,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144845,9 +144877,9 @@ webhooks: format: uri user_view_type: type: string - type: *208 - organization: *686 - repository: *687 + type: *214 + organization: *697 + repository: *698 sender: *4 required: - action @@ -145736,11 +145768,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145757,7 +145789,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -146339,11 +146371,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *721 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146423,12 +146455,12 @@ webhooks: type: string enum: - typed - enterprise: *684 - installation: *685 - issue: *711 - type: *208 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + type: *214 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146509,7 +146541,7 @@ webhooks: type: string enum: - unassigned - assignee: &735 + assignee: &746 title: User type: - object @@ -146581,11 +146613,11 @@ webhooks: required: - login - id - enterprise: *684 - installation: *685 - issue: *711 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146664,12 +146696,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - issue: *711 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146749,8 +146781,8 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147584,11 +147616,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147605,7 +147637,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -147685,8 +147717,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -147766,11 +147798,11 @@ webhooks: type: string enum: - unpinned - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *721 + organization: *697 + repository: *698 sender: *4 required: - action @@ -147849,12 +147881,12 @@ webhooks: type: string enum: - untyped - enterprise: *684 - installation: *685 - issue: *711 - type: *208 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + type: *214 + organization: *697 + repository: *698 sender: *4 required: - action @@ -147934,11 +147966,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -148016,11 +148048,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -148130,11 +148162,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -148216,9 +148248,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: &712 + enterprise: *695 + installation: *696 + marketplace_purchase: &723 title: Marketplace Purchase type: object required: @@ -148306,8 +148338,8 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: &713 + organization: *697 + previous_marketplace_purchase: &724 title: Marketplace Purchase type: object properties: @@ -148391,7 +148423,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *698 sender: *4 required: - action @@ -148471,10 +148503,10 @@ webhooks: - changed effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *695 + installation: *696 + marketplace_purchase: *723 + organization: *697 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148562,7 +148594,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *698 sender: *4 required: - action @@ -148644,10 +148676,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *695 + installation: *696 + marketplace_purchase: *723 + organization: *697 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148733,7 +148765,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *698 sender: *4 required: - action @@ -148814,8 +148846,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 marketplace_purchase: title: Marketplace Purchase type: object @@ -148901,9 +148933,9 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + organization: *697 + previous_marketplace_purchase: *724 + repository: *698 sender: *4 required: - action @@ -148983,12 +149015,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + enterprise: *695 + installation: *696 + marketplace_purchase: *723 + organization: *697 + previous_marketplace_purchase: *724 + repository: *698 sender: *4 required: - action @@ -149090,11 +149122,11 @@ webhooks: type: string required: - to - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149196,11 +149228,11 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149279,11 +149311,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149361,11 +149393,11 @@ webhooks: type: string enum: - added - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149443,7 +149475,7 @@ webhooks: required: - login - id - team: &714 + team: &725 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149673,11 +149705,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149756,7 +149788,7 @@ webhooks: required: - login - id - team: *714 + team: *725 required: - action - scope @@ -149838,8 +149870,8 @@ webhooks: type: string enum: - checks_requested - installation: *685 - merge_group: &715 + installation: *696 + merge_group: &726 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149858,15 +149890,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *394 + head_commit: *398 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149952,10 +149984,10 @@ webhooks: - merged - invalidated - dequeued - installation: *685 - merge_group: *715 - organization: *686 - repository: *687 + installation: *696 + merge_group: *726 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150028,7 +150060,7 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *695 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -150137,12 +150169,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *685 - organization: *686 + installation: *696 + organization: *697 repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -150222,11 +150254,11 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150305,9 +150337,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - milestone: &716 + enterprise: *695 + installation: *696 + milestone: &727 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150449,8 +150481,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150529,11 +150561,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150643,11 +150675,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150727,11 +150759,11 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - milestone: *716 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *727 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150810,11 +150842,11 @@ webhooks: type: string enum: - blocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *715 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150893,11 +150925,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *715 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150976,9 +151008,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - membership: &717 + enterprise: *695 + installation: *696 + membership: &728 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -151088,8 +151120,8 @@ webhooks: - role - organization_url - user - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151167,11 +151199,11 @@ webhooks: type: string enum: - member_added - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + membership: *728 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151250,8 +151282,8 @@ webhooks: type: string enum: - member_invited - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151373,10 +151405,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 - user: *704 + user: *715 required: - action - invitation @@ -151454,11 +151486,11 @@ webhooks: type: string enum: - member_removed - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + membership: *728 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151545,11 +151577,11 @@ webhooks: properties: from: type: string - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + membership: *728 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151625,9 +151657,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 package: description: Information about the package. type: object @@ -152150,7 +152182,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &718 + items: &729 title: Ruby Gems metadata type: object properties: @@ -152247,7 +152279,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -152323,9 +152355,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 package: description: Information about the package. type: object @@ -152687,7 +152719,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *729 source_url: type: string format: uri @@ -152758,7 +152790,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -152939,12 +152971,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *684 + enterprise: *695 id: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - id @@ -153021,7 +153053,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &719 + personal_access_token_request: &730 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -153171,10 +153203,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *684 - organization: *686 + enterprise: *695 + organization: *697 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153251,11 +153283,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *730 + enterprise: *695 + organization: *697 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153331,11 +153363,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *730 + enterprise: *695 + organization: *697 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153410,11 +153442,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *719 - organization: *686 - enterprise: *684 + personal_access_token_request: *730 + organization: *697 + enterprise: *695 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153519,7 +153551,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *720 + last_response: *731 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153551,8 +153583,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 zen: description: Random string of GitHub zen. @@ -153797,10 +153829,10 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: &721 + enterprise: *695 + installation: *696 + organization: *697 + project_card: &732 title: Project Card type: object properties: @@ -153923,7 +153955,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *698 sender: *4 required: - action @@ -154004,11 +154036,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_card: *732 + repository: *698 sender: *4 required: - action @@ -154088,9 +154120,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 project_card: title: Project Card type: object @@ -154220,7 +154252,7 @@ webhooks: repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -154314,11 +154346,11 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_card: *732 + repository: *698 sender: *4 required: - action @@ -154412,9 +154444,9 @@ webhooks: - from required: - column_id - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 project_card: allOf: - title: Project Card @@ -154611,7 +154643,7 @@ webhooks: type: string required: - after_id - repository: *687 + repository: *698 sender: *4 required: - action @@ -154691,10 +154723,10 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - organization: *686 - project: &723 + enterprise: *695 + installation: *696 + organization: *697 + project: &734 title: Project type: object properties: @@ -154821,7 +154853,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *698 sender: *4 required: - action @@ -154901,10 +154933,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_column: &722 + enterprise: *695 + installation: *696 + organization: *697 + project_column: &733 title: Project Column type: object properties: @@ -154944,7 +154976,7 @@ webhooks: - name - created_at - updated_at - repository: *687 + repository: *698 sender: *4 required: - action @@ -155023,14 +155055,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 + enterprise: *695 + installation: *696 + organization: *697 + project_column: *733 repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -155119,11 +155151,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_column: *733 + repository: *698 sender: *4 required: - action @@ -155203,11 +155235,11 @@ webhooks: type: string enum: - moved - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_column: *733 + repository: *698 sender: *4 required: - action @@ -155287,11 +155319,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 + repository: *698 sender: *4 required: - action @@ -155371,14 +155403,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project: *723 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -155479,11 +155511,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 + repository: *698 sender: *4 required: - action @@ -155562,11 +155594,11 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 + repository: *698 sender: *4 required: - action @@ -155647,9 +155679,9 @@ webhooks: type: string enum: - closed - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -155730,9 +155762,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -155813,9 +155845,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -155936,9 +155968,9 @@ webhooks: type: string to: type: string - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -156021,7 +156053,7 @@ webhooks: type: string enum: - archived - changes: &727 + changes: &738 type: object properties: archived_at: @@ -156037,9 +156069,9 @@ webhooks: - string - 'null' format: date-time - installation: *685 - organization: *686 - projects_v2_item: &724 + installation: *696 + organization: *697 + projects_v2_item: &735 title: Projects v2 Item description: An item belonging to a project type: object @@ -156057,7 +156089,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *247 + content_type: *253 creator: *4 created_at: type: string @@ -156179,9 +156211,9 @@ webhooks: - 'null' to: type: string - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156263,9 +156295,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156346,9 +156378,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156453,7 +156485,7 @@ webhooks: oneOf: - type: string - type: integer - - &725 + - &736 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156477,7 +156509,7 @@ webhooks: required: - id - name - - &726 + - &737 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156517,8 +156549,8 @@ webhooks: oneOf: - type: string - type: integer - - *725 - - *726 + - *736 + - *737 type: - 'null' - string @@ -156541,9 +156573,9 @@ webhooks: - 'null' required: - body - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156640,9 +156672,9 @@ webhooks: type: - string - 'null' - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156725,10 +156757,10 @@ webhooks: type: string enum: - restored - changes: *727 - installation: *685 - organization: *686 - projects_v2_item: *724 + changes: *738 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156810,9 +156842,9 @@ webhooks: type: string enum: - reopened - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -156893,9 +156925,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *696 + organization: *697 + projects_v2_status_update: *739 sender: *4 required: - action @@ -156976,9 +157008,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *696 + organization: *697 + projects_v2_status_update: *739 sender: *4 required: - action @@ -157124,9 +157156,9 @@ webhooks: - string - 'null' format: date - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *696 + organization: *697 + projects_v2_status_update: *739 sender: *4 required: - action @@ -157197,10 +157229,10 @@ webhooks: title: public event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - repository @@ -157277,13 +157309,13 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - number: &729 + assignee: *715 + enterprise: *695 + installation: *696 + number: &740 description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -159632,7 +159664,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -159714,11 +159746,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -162060,7 +162092,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *698 sender: *4 required: - action @@ -162142,11 +162174,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -164488,7 +164520,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *698 sender: *4 required: - action @@ -164570,13 +164602,13 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: &730 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: &741 allOf: - - *547 + - *551 - type: object properties: allow_auto_merge: @@ -164638,7 +164670,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *687 + repository: *698 sender: *4 required: - action @@ -164719,12 +164751,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -164804,11 +164836,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 - milestone: *244 - number: *729 - organization: *686 - pull_request: &731 + enterprise: *695 + milestone: *250 + number: *740 + organization: *697 + pull_request: &742 title: Pull Request type: object properties: @@ -167135,7 +167167,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -167214,11 +167246,11 @@ webhooks: type: string enum: - dequeued - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -169564,7 +169596,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *687 + repository: *698 sender: *4 required: - action @@ -169688,12 +169720,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -169773,11 +169805,11 @@ webhooks: type: string enum: - enqueued - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -172108,7 +172140,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -172188,11 +172220,11 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + label: *714 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -174540,7 +174572,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -174621,10 +174653,10 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -176970,7 +177002,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -177050,12 +177082,12 @@ webhooks: type: string enum: - milestoned - enterprise: *684 - milestone: *244 - number: *729 - organization: *686 - pull_request: *731 - repository: *687 + enterprise: *695 + milestone: *250 + number: *740 + organization: *697 + pull_request: *742 + repository: *698 sender: *4 required: - action @@ -177134,12 +177166,12 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -177220,12 +177252,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -177305,12 +177337,12 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -177685,9 +177717,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: type: object properties: @@ -179917,7 +179949,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *698 sender: *4 required: - action @@ -179997,7 +180029,7 @@ webhooks: type: string enum: - deleted - comment: &733 + comment: &744 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -180290,9 +180322,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: type: object properties: @@ -182510,7 +182542,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *698 sender: *4 required: - action @@ -182590,11 +182622,11 @@ webhooks: type: string enum: - edited - changes: *732 - comment: *733 - enterprise: *684 - installation: *685 - organization: *686 + changes: *743 + comment: *744 + enterprise: *695 + installation: *696 + organization: *697 pull_request: type: object properties: @@ -184815,7 +184847,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *698 sender: *4 required: - action @@ -184896,9 +184928,9 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -187131,7 +187163,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *698 review: description: The review that was affected. type: object @@ -187382,9 +187414,9 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -189498,8 +189530,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: &734 + repository: *698 + review: &745 description: The review that was affected. type: object properties: @@ -189737,12 +189769,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -192089,7 +192121,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_reviewer: title: User type: @@ -192175,12 +192207,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -194534,7 +194566,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194729,12 +194761,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -197083,7 +197115,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_reviewer: title: User type: @@ -197170,12 +197202,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -199515,7 +199547,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199699,9 +199731,9 @@ webhooks: type: string enum: - submitted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -201937,8 +201969,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: *734 + repository: *698 + review: *745 sender: *4 required: - action @@ -202018,9 +202050,9 @@ webhooks: type: string enum: - resolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -204151,7 +204183,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *698 sender: *4 thread: type: object @@ -204548,9 +204580,9 @@ webhooks: type: string enum: - unresolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -206664,7 +206696,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *698 sender: *4 thread: type: object @@ -207063,10 +207095,10 @@ webhooks: type: string before: type: string - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -209401,7 +209433,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -209483,11 +209515,11 @@ webhooks: type: string enum: - unassigned - assignee: *735 - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + assignee: *746 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -211837,7 +211869,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -211916,11 +211948,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + label: *714 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -214259,7 +214291,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -214340,10 +214372,10 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -216672,7 +216704,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -216875,7 +216907,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *684 + enterprise: *695 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216970,8 +217002,8 @@ webhooks: - url - author - committer - installation: *685 - organization: *686 + installation: *696 + organization: *697 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217559,9 +217591,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 registry_package: type: object properties: @@ -218038,7 +218070,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *718 + items: *729 summary: type: string tag_name: @@ -218094,7 +218126,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -218172,9 +218204,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 registry_package: type: object properties: @@ -218486,7 +218518,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *729 summary: type: string tag_name: @@ -218536,7 +218568,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -218613,10 +218645,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - release: &736 + enterprise: *695 + installation: *696 + organization: *697 + release: &747 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218947,7 +218979,7 @@ webhooks: - updated_at - zipball_url - body - repository: *687 + repository: *698 sender: *4 required: - action @@ -219024,11 +219056,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *747 + repository: *698 sender: *4 required: - action @@ -219145,11 +219177,11 @@ webhooks: type: boolean required: - to - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *747 + repository: *698 sender: *4 required: - action @@ -219227,9 +219259,9 @@ webhooks: type: string enum: - prereleased - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219565,7 +219597,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *698 sender: *4 required: - action @@ -219641,10 +219673,10 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - release: &737 + enterprise: *695 + installation: *696 + organization: *697 + release: &748 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219977,7 +220009,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *698 sender: *4 required: - action @@ -220053,11 +220085,11 @@ webhooks: type: string enum: - released - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *747 + repository: *698 sender: *4 required: - action @@ -220133,11 +220165,11 @@ webhooks: type: string enum: - unpublished - enterprise: *684 - installation: *685 - organization: *686 - release: *737 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *748 + repository: *698 sender: *4 required: - action @@ -220213,11 +220245,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_advisory: *615 sender: *4 required: - action @@ -220293,11 +220325,11 @@ webhooks: type: string enum: - reported - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_advisory: *615 sender: *4 required: - action @@ -220373,10 +220405,10 @@ webhooks: type: string enum: - archived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220453,10 +220485,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220534,10 +220566,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220622,10 +220654,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220740,10 +220772,10 @@ webhooks: - 'null' items: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220815,10 +220847,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 status: type: string @@ -220899,10 +220931,10 @@ webhooks: type: string enum: - privatized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220979,10 +221011,10 @@ webhooks: type: string enum: - publicized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221076,10 +221108,10 @@ webhooks: - name required: - repository - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221159,11 +221191,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_ruleset: *283 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_ruleset: *290 sender: *4 required: - action @@ -221241,11 +221273,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_ruleset: *283 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_ruleset: *290 sender: *4 required: - action @@ -221323,11 +221355,11 @@ webhooks: type: string enum: - edited - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_ruleset: *283 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_ruleset: *290 changes: type: object properties: @@ -221346,16 +221378,16 @@ webhooks: properties: added: type: array - items: *258 + items: *264 deleted: type: array - items: *258 + items: *264 updated: type: array items: type: object properties: - condition: *258 + condition: *264 changes: type: object properties: @@ -221388,16 +221420,16 @@ webhooks: properties: added: type: array - items: *568 + items: *571 deleted: type: array - items: *568 + items: *571 updated: type: array items: type: object properties: - rule: *568 + rule: *571 changes: type: object properties: @@ -221634,10 +221666,10 @@ webhooks: - from required: - owner - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221715,10 +221747,10 @@ webhooks: type: string enum: - unarchived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221796,7 +221828,7 @@ webhooks: type: string enum: - create - alert: &738 + alert: &749 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221920,10 +221952,10 @@ webhooks: type: string enum: - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222133,10 +222165,10 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222214,11 +222246,11 @@ webhooks: type: string enum: - reopen - alert: *738 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *749 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222420,10 +222452,10 @@ webhooks: enum: - fixed - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222441,7 +222473,7 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -222449,8 +222481,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To 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 + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -222494,24 +222526,24 @@ webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &739 + - assigned + alert: &750 type: object properties: - number: *154 - created_at: *155 + number: *160 + created_at: *161 updated_at: anyOf: - type: 'null' - - *156 - url: *157 - html_url: *158 + - *162 + url: *163 + html_url: *164 locations_url: type: string format: uri @@ -222615,10 +222647,93 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + assignee: *4 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222699,11 +222814,11 @@ webhooks: type: string enum: - created - alert: *739 - installation: *685 - location: *740 - organization: *686 - repository: *687 + alert: *750 + installation: *696 + location: *751 + organization: *697 + repository: *698 sender: *4 required: - location @@ -222941,11 +223056,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223023,11 +223138,11 @@ webhooks: type: string enum: - reopened - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223105,11 +223220,94 @@ webhooks: type: string enum: - resolved - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *750 + assignee: *4 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223187,11 +223385,11 @@ webhooks: type: string enum: - validated - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223321,10 +223519,10 @@ webhooks: - organization - enterprise - - repository: *687 - enterprise: *684 - installation: *685 - organization: *686 + repository: *698 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -223402,11 +223600,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: &741 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + security_advisory: &752 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223423,7 +223621,7 @@ webhooks: required: - vector_string - score - cvss_severities: *48 + cvss_severities: *52 cwes: type: array items: @@ -223592,11 +223790,11 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: *741 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + security_advisory: *752 sender: *4 required: - action @@ -223669,10 +223867,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223690,7 +223888,7 @@ webhooks: required: - vector_string - score - cvss_severities: *48 + cvss_severities: *52 cwes: type: array items: @@ -223858,11 +224056,11 @@ webhooks: from: type: object properties: - security_and_analysis: *257 - enterprise: *684 - installation: *685 - organization: *686 - repository: *317 + security_and_analysis: *263 + enterprise: *695 + installation: *696 + organization: *697 + repository: *319 sender: *4 required: - changes @@ -223940,12 +224138,12 @@ webhooks: type: string enum: - cancelled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: &742 + sponsorship: &753 type: object properties: created_at: @@ -224250,12 +224448,12 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - sponsorship @@ -224343,12 +224541,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - changes @@ -224425,17 +224623,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &743 + effective_date: &754 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: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - sponsorship @@ -224509,7 +224707,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &744 + changes: &755 type: object properties: tier: @@ -224553,13 +224751,13 @@ webhooks: - from required: - tier - effective_date: *743 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + effective_date: *754 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - changes @@ -224636,13 +224834,13 @@ webhooks: type: string enum: - tier_changed - changes: *744 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + changes: *755 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - changes @@ -224716,10 +224914,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224803,10 +225001,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225240,15 +225438,15 @@ webhooks: type: - string - 'null' - enterprise: *684 + enterprise: *695 id: description: The unique identifier of the status. type: integer - installation: *685 + installation: *696 name: type: string - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 sha: description: The Commit SHA. @@ -225358,15 +225556,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - parent_issue_repo: *64 + parent_issue: *82 + parent_issue_repo: *68 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + sub_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225450,15 +225648,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - parent_issue_repo: *64 + parent_issue: *82 + parent_issue_repo: *68 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + sub_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225542,15 +225740,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - sub_issue_repo: *64 + sub_issue: *82 + sub_issue_repo: *68 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + parent_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225634,15 +225832,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - sub_issue_repo: *64 + sub_issue: *82 + sub_issue_repo: *68 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + parent_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225719,12 +225917,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - team: &745 + team: &756 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225954,9 +226152,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -226426,7 +226624,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -226502,9 +226700,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -226974,7 +227172,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -227051,9 +227249,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -227523,7 +227721,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -227667,9 +227865,9 @@ webhooks: - from required: - permissions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -228139,7 +228337,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - changes @@ -228217,9 +228415,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -228689,7 +228887,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -228765,10 +228963,10 @@ webhooks: type: string enum: - started - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -228841,17 +229039,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *684 + enterprise: *695 inputs: type: - object - 'null' additionalProperties: true - installation: *685 - organization: *686 + installation: *696 + organization: *697 ref: type: string - repository: *687 + repository: *698 sender: *4 workflow: type: string @@ -228933,10 +229131,10 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: allOf: @@ -229192,7 +229390,7 @@ webhooks: type: string required: - conclusion - deployment: *463 + deployment: *467 required: - action - repository @@ -229271,10 +229469,10 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: allOf: @@ -229556,7 +229754,7 @@ webhooks: required: - status - steps - deployment: *463 + deployment: *467 required: - action - repository @@ -229635,10 +229833,10 @@ webhooks: type: string enum: - queued - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: type: object @@ -229784,7 +229982,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *463 + deployment: *467 required: - action - repository @@ -229863,10 +230061,10 @@ webhooks: type: string enum: - waiting - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: type: object @@ -230013,7 +230211,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *463 + deployment: *467 required: - action - repository @@ -230093,12 +230291,12 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: *699 + workflow: *710 workflow_run: title: Workflow Run type: object @@ -231117,12 +231315,12 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: *699 + workflow: *710 workflow_run: title: Workflow Run type: object @@ -232126,12 +232324,12 @@ webhooks: type: string enum: - requested - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: *699 + workflow: *710 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 b8794fd6f..e20e7b232 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 @@ -104,10 +104,6 @@ "name": "packages", "description": "Manage packages for authenticated users and organizations." }, - { - "name": "projects-classic", - "description": "Interact with GitHub Projects (classic)." - }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." @@ -5443,6 +5439,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -6575,6 +6579,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7480,6 +7492,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -7950,6 +7970,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -10278,6 +10306,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -11442,6 +11478,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -12470,6 +12514,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -13201,6 +13253,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -18515,17 +18575,17 @@ } } }, - "/enterprises/{enterprise}/code-security/configurations": { + "/enterprises/{enterprise}/actions/cache/retention-limit": { "get": { - "summary": "Get code security configurations for an enterprise", - "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "summary": "Get GitHub Actions cache retention limit for an enterprise", + "description": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", "tags": [ - "code-security" + "actions" ], - "operationId": "code-security/get-configurations-for-enterprise", + "operationId": "actions/get-actions-cache-retention-limit-for-enterprise", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise" }, "parameters": [ { @@ -18536,34 +18596,6 @@ "schema": { "type": "string" } - }, - { - "name": "per_page", - "in": "query", - "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).\"", - "required": false, - "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" - } } ], "responses": { @@ -18572,345 +18604,963 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "description": "A code security configuration", - "properties": { - "id": { - "type": "integer", - "description": "The ID of the code security configuration" - }, - "name": { - "type": "string", - "description": "The name of the code security configuration. Must be unique within the organization." - }, - "target_type": { - "type": "string", - "description": "The type of the code security configuration.", - "enum": [ - "global", - "organization", - "enterprise" - ] - }, - "description": { - "type": "string", - "description": "A description of the code security configuration" - }, - "advanced_security": { - "type": "string", - "description": "The enablement status of GitHub Advanced Security", - "enum": [ - "enabled", - "disabled", - "code_security", - "secret_protection" - ] - }, - "dependency_graph": { - "type": "string", - "description": "The enablement status of Dependency Graph", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action": { - "type": "string", - "description": "The enablement status of Automatic dependency submission", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependency_graph_autosubmit_action_options": { - "type": "object", - "description": "Feature options for Automatic dependency submission", - "properties": { - "labeled_runners": { - "type": "boolean", - "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." - } - } - }, - "dependabot_alerts": { - "type": "string", - "description": "The enablement status of Dependabot alerts", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "dependabot_security_updates": { - "type": "string", - "description": "The enablement status of Dependabot security updates", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_options": { - "type": [ - "object", - "null" - ], - "description": "Feature options for code scanning", - "properties": { - "allow_advanced": { - "type": [ - "boolean", - "null" - ], - "description": "Whether to allow repos which use advanced setup" - } - } - }, - "code_scanning_default_setup": { - "type": "string", - "description": "The enablement status of code scanning default setup", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "code_scanning_default_setup_options": { - "type": [ - "object", - "null" - ], - "description": "Feature options for code scanning default setup", - "properties": { - "runner_type": { - "type": [ - "string", - "null" - ], - "enum": [ - "standard", - "labeled", - "not_set", - null - ], - "description": "Whether to use labeled runners or standard GitHub runners." - }, - "runner_label": { - "type": [ - "string", - "null" - ], - "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." - } - } - }, - "code_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of code scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning": { - "type": "string", - "description": "The enablement status of secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_push_protection": { - "type": "string", - "description": "The enablement status of secret scanning push protection", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass": { - "type": "string", - "description": "The enablement status of secret scanning delegated bypass", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_bypass_options": { - "type": "object", - "description": "Feature options for secret scanning delegated bypass", - "properties": { - "reviewers": { - "type": "array", - "description": "The bypass reviewers for secret scanning delegated bypass", - "items": { - "type": "object", - "required": [ - "reviewer_id", - "reviewer_type" - ], - "properties": { - "reviewer_id": { - "type": "integer", - "description": "The ID of the team or role selected as a bypass reviewer" - }, - "reviewer_type": { - "type": "string", - "description": "The type of the bypass reviewer", - "enum": [ - "TEAM", - "ROLE" - ] - } - } - } - } - } - }, - "secret_scanning_validity_checks": { - "type": "string", - "description": "The enablement status of secret scanning validity checks", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_non_provider_patterns": { - "type": "string", - "description": "The enablement status of secret scanning non-provider patterns", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_generic_secrets": { - "type": "string", - "description": "The enablement status of Copilot secret scanning", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "secret_scanning_delegated_alert_dismissal": { - "type": "string", - "description": "The enablement status of secret scanning delegated alert dismissal", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "private_vulnerability_reporting": { - "type": "string", - "description": "The enablement status of private vulnerability reporting", - "enum": [ - "enabled", - "disabled", - "not_set" - ] - }, - "enforcement": { - "type": "string", - "description": "The enforcement status for a security configuration", - "enum": [ - "enforced", - "unenforced" - ] - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "html_url": { - "type": "string", - "format": "uri", - "description": "The URL of the configuration" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] } } }, "examples": { "default": { - "value": [ - { - "id": 17, - "target_type": "global", - "name": "GitHub recommended", - "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "not_set", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "not_set", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_validity_checks": "enabled", - "secret_scanning_non_provider_patterns": "enabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", - "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", - "created_at": "2023-12-04T15:58:07Z", - "updated_at": "2023-12-04T15:58:07Z" - }, - { - "id": 1326, - "target_type": "enterprise", - "name": "High risk settings", - "description": "This is a code security configuration for octo-enterprise high risk repositories", - "advanced_security": "enabled", - "dependency_graph": "enabled", - "dependency_graph_autosubmit_action": "enabled", - "dependency_graph_autosubmit_action_options": { - "labeled_runners": false - }, - "dependabot_alerts": "enabled", - "dependabot_security_updates": "enabled", - "code_scanning_default_setup": "enabled", - "code_scanning_default_setup_options": { - "runner_type": "not_set", - "runner_label": null - }, - "secret_scanning": "enabled", - "secret_scanning_push_protection": "enabled", - "secret_scanning_validity_checks": "disabled", - "secret_scanning_non_provider_patterns": "disabled", - "private_vulnerability_reporting": "enabled", - "enforcement": "enforced", - "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", - "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", - "created_at": "2024-05-10T00:00:00Z", - "updated_at": "2024-05-10T00:00:00Z" - } - ] + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an enterprise", + "description": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-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": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an enterprise", + "description": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an enterprise", + "description": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/enterprises/{enterprise}/code-security/configurations": { + "get": { + "summary": "Get code security configurations for an enterprise", + "description": "Lists all code security configurations available in an enterprise.\n\nThe authenticated user must be an administrator of the enterprise in order to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint.", + "tags": [ + "code-security" + ], + "operationId": "code-security/get-configurations-for-enterprise", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "in": "query", + "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).\"", + "required": false, + "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" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "description": "A code security configuration", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the code security configuration" + }, + "name": { + "type": "string", + "description": "The name of the code security configuration. Must be unique within the organization." + }, + "target_type": { + "type": "string", + "description": "The type of the code security configuration.", + "enum": [ + "global", + "organization", + "enterprise" + ] + }, + "description": { + "type": "string", + "description": "A description of the code security configuration" + }, + "advanced_security": { + "type": "string", + "description": "The enablement status of GitHub Advanced Security", + "enum": [ + "enabled", + "disabled", + "code_security", + "secret_protection" + ] + }, + "dependency_graph": { + "type": "string", + "description": "The enablement status of Dependency Graph", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action": { + "type": "string", + "description": "The enablement status of Automatic dependency submission", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependency_graph_autosubmit_action_options": { + "type": "object", + "description": "Feature options for Automatic dependency submission", + "properties": { + "labeled_runners": { + "type": "boolean", + "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners." + } + } + }, + "dependabot_alerts": { + "type": "string", + "description": "The enablement status of Dependabot alerts", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "dependabot_security_updates": { + "type": "string", + "description": "The enablement status of Dependabot security updates", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning", + "properties": { + "allow_advanced": { + "type": [ + "boolean", + "null" + ], + "description": "Whether to allow repos which use advanced setup" + } + } + }, + "code_scanning_default_setup": { + "type": "string", + "description": "The enablement status of code scanning default setup", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "code_scanning_default_setup_options": { + "type": [ + "object", + "null" + ], + "description": "Feature options for code scanning default setup", + "properties": { + "runner_type": { + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + "not_set", + null + ], + "description": "Whether to use labeled runners or standard GitHub runners." + }, + "runner_label": { + "type": [ + "string", + "null" + ], + "description": "The label of the runner to use for code scanning when runner_type is 'labeled'." + } + } + }, + "code_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of code scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning": { + "type": "string", + "description": "The enablement status of secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_push_protection": { + "type": "string", + "description": "The enablement status of secret scanning push protection", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass": { + "type": "string", + "description": "The enablement status of secret scanning delegated bypass", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_bypass_options": { + "type": "object", + "description": "Feature options for secret scanning delegated bypass", + "properties": { + "reviewers": { + "type": "array", + "description": "The bypass reviewers for secret scanning delegated bypass", + "items": { + "type": "object", + "required": [ + "reviewer_id", + "reviewer_type" + ], + "properties": { + "reviewer_id": { + "type": "integer", + "description": "The ID of the team or role selected as a bypass reviewer" + }, + "reviewer_type": { + "type": "string", + "description": "The type of the bypass reviewer", + "enum": [ + "TEAM", + "ROLE" + ] + } + } + } + } + } + }, + "secret_scanning_validity_checks": { + "type": "string", + "description": "The enablement status of secret scanning validity checks", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_non_provider_patterns": { + "type": "string", + "description": "The enablement status of secret scanning non-provider patterns", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_generic_secrets": { + "type": "string", + "description": "The enablement status of Copilot secret scanning", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "private_vulnerability_reporting": { + "type": "string", + "description": "The enablement status of private vulnerability reporting", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement status for a security configuration", + "enum": [ + "enforced", + "unenforced" + ] + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "html_url": { + "type": "string", + "format": "uri", + "description": "The URL of the configuration" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 17, + "target_type": "global", + "name": "GitHub recommended", + "description": "Suggested settings for Dependabot, secret scanning, and code scanning.", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "not_set", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "not_set", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "enabled", + "secret_scanning_non_provider_patterns": "enabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/17", + "html_url": "https://github.com/organizations/octo-enterprise/settings/security_analysis/configurations/17/view", + "created_at": "2023-12-04T15:58:07Z", + "updated_at": "2023-12-04T15:58:07Z" + }, + { + "id": 1326, + "target_type": "enterprise", + "name": "High risk settings", + "description": "This is a code security configuration for octo-enterprise high risk repositories", + "advanced_security": "enabled", + "dependency_graph": "enabled", + "dependency_graph_autosubmit_action": "enabled", + "dependency_graph_autosubmit_action_options": { + "labeled_runners": false + }, + "dependabot_alerts": "enabled", + "dependabot_security_updates": "enabled", + "code_scanning_default_setup": "enabled", + "code_scanning_default_setup_options": { + "runner_type": "not_set", + "runner_label": null + }, + "secret_scanning": "enabled", + "secret_scanning_push_protection": "enabled", + "secret_scanning_validity_checks": "disabled", + "secret_scanning_non_provider_patterns": "disabled", + "private_vulnerability_reporting": "enabled", + "enforcement": "enforced", + "url": "https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1326", + "html_url": "https://github.com/enterprises/octo-enterprise/settings/security_analysis/configurations/1326/edit", + "created_at": "2024-05-10T00:00:00Z", + "updated_at": "2024-05-10T00:00:00Z" + } + ] } } } @@ -60378,6 +61028,596 @@ } } }, + "/organizations/{org}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for an organization", + "description": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-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": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for an organization", + "description": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-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": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/organizations/{org}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for an organization", + "description": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for an organization", + "description": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.\n\nOAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-organization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-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": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/organizations/{org}/dependabot/repository-access": { "get": { "summary": "Lists the repositories Dependabot can access in an organization", @@ -61824,6 +63064,47 @@ "schema": { "type": "string" } + }, + { + "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 + } + }, + { + "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_size", + "description": "The number of results per page (max 10).", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost-center" + ] + } } ], "responses": { @@ -61925,6 +63206,10 @@ ] }, "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ @@ -62593,7 +63878,22 @@ "update-budget": { "value": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0.0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } } } } @@ -117213,6 +118513,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -118360,6 +119668,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -160065,19 +161381,17 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for organization", - "description": "Get a specific field for an organization-owned project.", + }, + "post": { + "summary": "Add a field to an organization-owned project.", + "description": "Add a field to an organization-owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-org", + "operationId": "projects/add-field-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + "url": "https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project" }, "parameters": [ { @@ -160089,15 +161403,6 @@ "type": "integer" } }, - { - "name": "field_id", - "description": "The unique identifier of the field.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.", @@ -160108,9 +161413,761 @@ } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "issue_field_id": { + "type": "integer", + "description": "The ID of the IssueField to create the field for." + } + }, + "required": [ + "issue_field_id" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { - "description": "Response", + "201": { + "description": "Response for adding a field to an organization-owned project.", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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": "projects", + "subcategory": "fields" + } + } + }, + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for organization", + "description": "Get a specific field for an organization-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-organization" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "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": { @@ -160316,21 +162373,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -183868,7 +185943,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -184506,7 +186581,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -185154,7 +187229,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -185789,6 +187864,35 @@ ] } } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } } ] } @@ -186501,7 +188605,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -187139,7 +189243,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -188535,7 +190639,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -189173,7 +191277,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -189846,7 +191950,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -190481,6 +192585,35 @@ ] } } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } } ] } @@ -191189,7 +193322,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -191827,7 +193960,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -192534,6 +194667,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -211879,17 +214035,17 @@ } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/repos": { "get": { - "summary": "List team projects", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" }, "parameters": [ { @@ -211937,44 +214093,36 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -212142,55 +214290,660 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "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", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -212198,17 +214951,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -212228,1607 +214975,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "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}", + "git_url": "git:github.com/octocat/Hello-World.git", + "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}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "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}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Updates the permissions for the team to write for the project", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "teams", - "subcategory": "teams", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n> [!NOTE]\n> You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team 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/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": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "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}", - "git_url": "git:github.com/octocat/Hello-World.git", - "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}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "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}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -215562,152 +216799,463 @@ "deprecated": true } }, - "/projects/columns/{column_id}": { + "/rate_limit": { "get": { - "summary": "Get a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "Get rate limit status for the authenticated user", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ - "projects-classic" + "rate-limit" ], - "operationId": "projects-classic/get-column", + "operationId": "rate-limit/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#get-a-project-column" + "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], + "parameters": [], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "scim": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_snapshots": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + } + }, + "required": [ + "core", + "search" ] }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" ] } }, "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" + "rate", + "resources" ] }, "examples": { "default": { "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "resources": { + "core": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691591363 + }, + "search": { + "limit": 30, + "used": 12, + "remaining": 18, + "reset": 1691591091 + }, + "graphql": { + "limit": 5000, + "used": 7, + "remaining": 4993, + "reset": 1691593228 + }, + "integration_manifest": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1691594631 + }, + "source_import": { + "limit": 100, + "used": 1, + "remaining": 99, + "reset": 1691591091 + }, + "code_scanning_upload": { + "limit": 500, + "used": 1, + "remaining": 499, + "reset": 1691594631 + }, + "actions_runner_registration": { + "limit": 10000, + "used": 0, + "remaining": 10000, + "reset": 1691594631 + }, + "scim": { + "limit": 15000, + "used": 0, + "remaining": 15000, + "reset": 1691594631 + }, + "dependency_snapshots": { + "limit": 100, + "used": 0, + "remaining": 100, + "reset": 1691591091 + }, + "code_search": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 + } + }, + "rate": { + "limit": 5000, + "used": 1, + "remaining": 4999, + "reset": 1372700873 + } } } } } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } + "type": "integer" + } + }, + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" } } } }, + "304": { + "description": "Not modified" + }, "404": { "description": "Resource not found", "content": { @@ -215733,3136 +217281,839 @@ } } } - }, - "401": { - "description": "Requires authentication", - "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": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "patch": { - "summary": "Update an existing project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "category": "rate-limit", + "subcategory": "rate-limit" + } + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", "tags": [ - "projects-classic" + "repos" ], - "operationId": "projects-classic/update-column", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column" + "url": "https://docs.github.com/rest/repos/repos#get-a-repository" }, "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.", + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - } - }, - "required": [ - "name" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Rename the project column", - "value": { - "name": "To Do" - } - } - } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Full Repository", + "description": "Full Repository", "type": "object", "properties": { - "url": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367" + "Hello-World" ] }, - "project_url": { + "full_name": { + "type": "string", + "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" + }, + "html_url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/120" + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" ] }, - "cards_url": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", "format": "uri", "examples": [ - "https://api.github.com/projects/columns/367/cards" + "https://api.github.com/repos/octocat/Hello-World" ] }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", + "archive_url": { + "type": "string", "examples": [ - 42 + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, - "node_id": { + "assignees_url": { "type": "string", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "name": { - "description": "Name of the project column", + "blobs_url": { "type": "string", "examples": [ - "Remaining tasks" + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, - "created_at": { + "branches_url": { "type": "string", - "format": "date-time", "examples": [ - "2016-09-05T14:18:44Z" + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "updated_at": { + "collaborators_url": { "type": "string", - "format": "date-time", "examples": [ - "2016-09-05T14:22:28Z" + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] }, - "url": { - "type": "string" + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] }, - "documentation_url": { - "type": "string" + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] }, - "url": { - "type": "string" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Delete a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "documentation_url": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] }, - "url": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] }, - "documentation_url": { - "type": "string" + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] }, - "url": { - "type": "string" + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/columns#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "examples": [ - "last" - ] - } - }, - "required": [ - "position" - ], - "type": "object" - }, - "examples": { - "default": { - "summary": "Move the column to the end of the board", - "value": { - "position": "last" - } - } - } - } - } - }, - "responses": { - "201": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - }, - "examples": { - "default": { - "value": null - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] }, - "documentation_url": { - "type": "string" + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] }, - "url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] }, - "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" + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] }, - "documentation_url": { - "type": "string" + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] }, - "url": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "columns", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/list-collaborators", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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 organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" - } - }, - { - "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": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "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" - ] - } + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] }, - "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": [ - { - "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" + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] }, - "url": { - "type": "string" + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] }, - "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" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] }, - "documentation_url": { - "type": "string" + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] }, - "documentation_url": { - "type": "string" + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, - "url": { - "type": "string" + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] }, - "documentation_url": { - "type": "string" + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "url": { - "type": "string" + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/add-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": [ - "object", - "null" - ], - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "type": "string", - "examples": [ - "write" - ] - } - } - }, - "examples": { - "default": { - "summary": "Applying write permissions for the new collaborator", - "value": { - "permission": "write" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] }, - "documentation_url": { - "type": "string" + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] }, - "url": { - "type": "string" + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] }, - "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" + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] }, - "documentation_url": { - "type": "string" + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] }, - "documentation_url": { - "type": "string" + "language": { + "type": [ + "string", + "null" + ] }, - "url": { - "type": "string" + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] }, - "documentation_url": { - "type": "string" + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] }, - "url": { - "type": "string" + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/remove-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "304": { - "description": "Not modified" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "type": "string", + "examples": [ + "master" + ] }, - "documentation_url": { - "type": "string" + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] }, - "url": { - "type": "string" + "is_template": { + "type": "boolean", + "examples": [ + true + ] }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, - "documentation_url": { - "type": "string" + "has_issues": { + "type": "boolean", + "examples": [ + true + ] }, - "url": { - "type": "string" + "has_projects": { + "type": "boolean", + "examples": [ + true + ] }, - "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" + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] }, - "documentation_url": { - "type": "string" + "has_pages": { + "type": "boolean" }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] }, - "documentation_url": { - "type": "string" + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] }, - "url": { - "type": "string" + "archived": { + "type": "boolean" }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "projects-classic" - ], - "operationId": "projects-classic/get-permission-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user" - }, - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - "user": { + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" + ] + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { "anyOf": [ { "type": "null" }, { - "title": "Simple User", - "description": "A GitHub user.", + "title": "Repository", + "description": "A repository on GitHub.", "type": "object", "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, "id": { + "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [ - 1 + 42 ] }, "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" + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - "events_url": { + "name": { + "description": "The name of the repository.", "type": "string", "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" + "Team Environment" ] }, - "received_events_url": { + "full_name": { "type": "string", - "format": "uri", "examples": [ - "https://api.github.com/users/octocat/received_events" + "octocat/Hello-World" ] }, - "type": { - "type": "string", - "examples": [ - "User" + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } ] }, - "site_admin": { - "type": "boolean" + "forks": { + "type": "integer" }, - "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": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "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 - } - } - } - } - } - } - }, - "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" - } - } - ] - } - } - } - } - } - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "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": "projects-classic", - "subcategory": "collaborators", - "deprecationDate": "2024-05-23", - "removalDate": "2025-04-01" - }, - "deprecated": true - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { - "type": "object", - "properties": { - "core": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "actions_runner_registration": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "scim": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_snapshots": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "dependency_sbom": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - }, - "code_scanning_autofix": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "core", - "search" - ] - }, - "rate": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - }, - "used": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset", - "used" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691591363 - }, - "search": { - "limit": 30, - "used": 12, - "remaining": 18, - "reset": 1691591091 - }, - "graphql": { - "limit": 5000, - "used": 7, - "remaining": 4993, - "reset": 1691593228 - }, - "integration_manifest": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1691594631 - }, - "source_import": { - "limit": 100, - "used": 1, - "remaining": 99, - "reset": 1691591091 - }, - "code_scanning_upload": { - "limit": 500, - "used": 1, - "remaining": 499, - "reset": 1691594631 - }, - "actions_runner_registration": { - "limit": 10000, - "used": 0, - "remaining": 10000, - "reset": 1691594631 - }, - "scim": { - "limit": 15000, - "used": 0, - "remaining": 15000, - "reset": 1691594631 - }, - "dependency_snapshots": { - "limit": 100, - "used": 0, - "remaining": 100, - "reset": 1691591091 - }, - "code_search": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - }, - "code_scanning_autofix": { - "limit": 10, - "used": 0, - "remaining": 10, - "reset": 1691591091 - } - }, - "rate": { - "limit": 5000, - "used": 1, - "remaining": 4999, - "reset": 1372700873 - } - } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" - } - } - } - }, - "304": { - "description": "Not modified" - }, - "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": "rate-limit", - "subcategory": "rate-limit" - } - } - }, - "/repos/{owner}/{repo}": { - "get": { - "summary": "Get a repository", - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n> [!NOTE]\n> - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n> - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions.", - "tags": [ - "repos" - ], - "operationId": "repos/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/repos/repos#get-a-repository" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Repository", - "description": "A repository on GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "examples": [ - "Team Environment" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "mit" - ] - }, - "name": { - "type": "string", - "examples": [ - "MIT License" - ] - }, - "url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://api.github.com/licenses/mit" - ] - }, - "spdx_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "MIT" - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6TGljZW5zZW1pdA==" - ] - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" ] }, "owner": { @@ -228624,6 +227875,632 @@ } } }, + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + "get": { + "summary": "Get GitHub Actions cache retention limit for a repository", + "description": "Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache retention limit for a repository", + "description": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-retention-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_retention_days": 80 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + "get": { + "summary": "Get GitHub Actions cache storage limit for a repository", + "description": "Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "default": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "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": "actions", + "subcategory": "cache" + } + }, + "put": { + "summary": "Set GitHub Actions cache storage limit for a repository", + "description": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.\n\nOAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-actions-cache-storage-limit-for-repository", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + }, + "examples": { + "selected_actions": { + "value": { + "max_cache_size_gb": 150 + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Response" + }, + "400": { + "description": "Bad Request", + "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" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "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": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "cache" + } + } + }, "/repos/{owner}/{repo}/actions/cache/usage": { "get": { "summary": "Get GitHub Actions cache usage for a repository", @@ -258476,6 +258353,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -258508,6 +258386,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -279936,6 +279815,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -279968,6 +279848,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -321788,6 +321669,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -321820,6 +321702,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -328830,6 +328713,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -328862,6 +328746,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -335268,6 +335153,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -335300,6 +335186,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -335988,6 +335875,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -336020,6 +335908,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -336740,6 +336629,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -336772,6 +336662,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -375505,6 +375396,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -400314,8 +400213,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -478811,6 +478709,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -478843,6 +478742,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -516344,6 +516244,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -516376,6 +516277,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -541209,7 +541111,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -542211,7 +542113,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -543036,7 +542938,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -543674,7 +543576,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -544189,7 +544091,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -544827,7 +544729,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -545555,7 +545457,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -546193,7 +546095,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -547608,7 +547510,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -548246,7 +548148,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -548776,7 +548678,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -549414,7 +549316,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -550138,7 +550040,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -550776,7 +550678,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -551499,6 +551401,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.", + "required": false, + "schema": { + "type": "string" + }, + "examples": { + "assigned-to-user": { + "value": "octocat", + "summary": "Filter for alerts assigned to the user \"octocat\"" + }, + "all-assigned": { + "value": "*", + "summary": "Filter for all assigned alerts" + }, + "all-unassigned": { + "value": "none", + "summary": "Filter for all unassigned alerts" + } + } + }, { "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.", @@ -554285,7 +554210,7 @@ }, "patch": { "summary": "Update a secret scanning alert", - "description": "Updates the status of a secret scanning alert in an eligible repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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": "Updates the status of a secret scanning alert in an eligible repository.\n\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.\n\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.\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.", "operationId": "secret-scanning/update-alert", "tags": [ "secret-scanning" @@ -554360,6 +554285,13 @@ "string", "null" ] + }, + "assignee": { + "description": "The username of the user to assign to the alert. Set to `null` to unassign the alert.", + "type": [ + "string", + "null" + ] } }, "anyOf": [ @@ -554367,6 +554299,11 @@ "required": [ "state" ] + }, + { + "required": [ + "assignee" + ] } ] }, @@ -554376,6 +554313,18 @@ "state": "resolved", "resolution": "false_positive" } + }, + "assign": { + "summary": "Assign alert to a user", + "value": { + "assignee": "octocat" + } + }, + "unassign": { + "summary": "Unassign alert", + "value": { + "assignee": null + } } } } @@ -555625,7 +555574,27 @@ "resolution_comment": "Example comment", "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "assigned_to": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://alambic.github.com/avatars/u/1?", + "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 + } } } } @@ -555639,7 +555608,7 @@ "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found" }, "422": { - "description": "State does not match the resolution or resolution comment" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository" }, "503": { "description": "Service unavailable", @@ -587991,6 +587960,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -588271,6 +588241,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -603707,17 +603678,17 @@ "deprecated": true } }, - "/teams/{team_id}/projects": { + "/teams/{team_id}/repos": { "get": { - "summary": "List team projects (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", + "summary": "List team repositories (Legacy)", + "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", "tags": [ "teams" ], - "operationId": "teams/list-projects-legacy", + "operationId": "teams/list-repos-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-projects-legacy" + "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" }, "parameters": [ { @@ -603756,44 +603727,36 @@ "schema": { "type": "array", "items": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, "id": { - "type": "integer" + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] }, "node_id": { - "type": "string" + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] }, "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" + "type": "string", + "examples": [ + "Hello-World" ] }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] }, - "creator": { + "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", @@ -603961,55 +603924,660 @@ "url" ] }, - "created_at": { + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { "type": "string" }, - "updated_at": { + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string" }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { "type": "string" }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, "permissions": { "type": "object", "properties": { - "read": { + "admin": { "type": "boolean" }, - "write": { + "maintain": { "type": "boolean" }, - "admin": { + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { "type": "boolean" } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } }, "required": [ - "read", - "write", - "admin" + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "code_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ - "owner_url", - "url", + "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", - "columns_url", "id", "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" ] } }, @@ -604017,17 +604585,11 @@ "default": { "value": [ { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -604047,1796 +604609,97 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", "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}", + "git_url": "git:github.com/octocat/Hello-World.git", + "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}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "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}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "has_discussions": false, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", "permissions": { - "read": true, - "write": true, - "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" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/check-permissions-for-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - }, - "examples": { - "default": { - "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "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 - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Not Found if project is not managed by this team" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "put": { - "summary": "Add or update team project permissions (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-project-permissions-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see \"[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - } - }, - "examples": { - "default": { - "summary": "Example of setting permission to read", - "value": { - "permission": "read" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions" - } - } - } - } - } - }, - "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, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - }, - "delete": { - "summary": "Remove a project from a team (Legacy)", - "description": "> [!WARNING]\n> **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience.\n> See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-project-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "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, - "removalDate": "2025-04-01", - "deprecationDate": "2024-05-23", - "category": "teams", - "subcategory": "teams" - }, - "deprecated": true - } - }, - "/teams/{team_id}/repos": { - "get": { - "summary": "List team repositories (Legacy)", - "description": "> [!WARNING]\n> **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-legacy", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/teams/teams#list-team-repositories-legacy" - }, - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "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": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "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" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": [ - "string", - "null" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": [ - "string", - "null" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "has_discussions": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "role_name": { - "type": "string", - "examples": [ - "admin" - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "code_of_conduct": { - "title": "Code Of Conduct", - "description": "Code Of Conduct", - "type": "object", - "properties": { - "key": { - "type": "string", - "examples": [ - "contributor_covenant" - ] - }, - "name": { - "type": "string", - "examples": [ - "Contributor Covenant" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/codes_of_conduct/contributor_covenant" - ] - }, - "body": { - "type": "string", - "examples": [ - "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri" - } - }, - "required": [ - "url", - "html_url", - "key", - "name" - ] - }, - "license": { - "type": [ - "object", - "null" - ], - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - } - }, - "forks": { - "type": "integer", - "examples": [ - 0 - ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 0 - ] - }, - "watchers": { - "type": "integer", - "examples": [ - 0 - ] - }, - "allow_forking": { - "type": "boolean" - }, - "web_commit_signoff_required": { - "type": "boolean", - "examples": [ - false - ] - }, - "security_and_analysis": { - "type": [ - "object", - "null" - ], - "properties": { - "advanced_security": { - "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "code_security": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "dependabot_security_updates": { - "description": "Enable or disable Dependabot security updates for the repository.", - "type": "object", - "properties": { - "status": { - "description": "The enablement status of Dependabot security updates for the repository.", - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_push_protection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_non_provider_patterns": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - }, - "secret_scanning_ai_detection": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "enabled", - "disabled" - ] - } - } - } - } - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true - } - }, - "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" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "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}", - "git_url": "git:github.com/octocat/Hello-World.git", - "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}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "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}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "has_discussions": false, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "security_and_analysis": { - "advanced_security": { - "status": "enabled" - }, - "secret_scanning": { - "status": "enabled" - }, - "secret_scanning_push_protection": { - "status": "disabled" - }, - "secret_scanning_non_provider_patterns": { - "status": "disabled" - } + "admin": false, + "push": false, + "pull": true + }, + "security_and_analysis": { + "advanced_security": { + "status": "enabled" + }, + "secret_scanning": { + "status": "enabled" + }, + "secret_scanning_push_protection": { + "status": "disabled" + }, + "secret_scanning_non_provider_patterns": { + "status": "disabled" + } } } ] @@ -637273,6 +636136,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -696490,6 +695361,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -703951,51 +702830,280 @@ "category": "projects", "subcategory": "fields" } - } - }, - "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { - "get": { - "summary": "Get project field for user", - "description": "Get a specific field for a user-owned project.", + }, + "post": { + "summary": "Add field to user owned project", + "description": "Add a field to a specified user owned project.", "tags": [ "projects" ], - "operationId": "projects/get-field-for-user", + "operationId": "projects/add-field-for-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + "url": "https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project" }, "parameters": [ { - "name": "project_number", - "description": "The project's number.", + "name": "username", + "description": "The handle for the GitHub user account.", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.", + "name": "project_number", + "description": "The project's number.", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "text", + "number", + "date" + ] + } + }, + "required": [ + "name", + "data_type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "single_select" + ] + }, + "single_select_options": { + "type": "array", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The display name of the option." + }, + "color": { + "type": "string", + "description": "The color associated with the option.", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + "description": { + "type": "string", + "description": "The description of the option." + } + } + } + } + }, + "required": [ + "name", + "data_type", + "single_select_options" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "iteration" + ] + }, + "iteration_configuration": { + "type": "object", + "description": "The configuration for iteration fields.", + "properties": { + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the first iteration." + }, + "duration": { + "type": "integer", + "description": "The default duration for iterations in days. Individual iterations can override this value." + }, + "iterations": { + "type": "array", + "description": "Zero or more iterations for the field.", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the iteration." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + } + } + } + } + } + } + }, + "required": [ + "name", + "data_type", + "iteration_configuration" + ], + "additionalProperties": false + } + ] + }, + "examples": { + "text_field": { + "summary": "Create a text field", + "value": { + "name": "Team notes", + "data_type": "text" + } + }, + "number_field": { + "summary": "Create a number field", + "value": { + "name": "Story points", + "data_type": "number" + } + }, + "date_field": { + "summary": "Create a date field", + "value": { + "name": "Due date", + "data_type": "date" + } + }, + "single_select_field": { + "summary": "Create a single select field", + "value": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + } + }, + "iteration_field": { + "summary": "Create an iteration field", + "value": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + } + } + } + } + } + }, "responses": { - "200": { + "201": { "description": "Response", "content": { "application/json": { @@ -704192,7 +703300,40 @@ ] }, "examples": { - "default": { + "text_field": { + "value": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + } + }, + "number_field": { + "value": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + } + }, + "date_field": { + "value": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + } + }, + "single_select_field": { "value": { "id": 12345, "node_id": "PVTF_lADOABCD1234567890", @@ -704202,37 +703343,521 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", "updated_at": "2022-04-28T12:00:00Z" } + }, + "iteration_field": { + "value": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } + } + }, + "304": { + "description": "Not modified" + }, + "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" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "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": "projects", + "subcategory": "fields" + } + } + }, + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + "get": { + "summary": "Get project field for user", + "description": "Get a specific field for a user-owned project.", + "tags": [ + "projects" + ], + "operationId": "projects/get-field-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/projects/fields#get-project-field-for-user" + }, + "parameters": [ + { + "name": "project_number", + "description": "The project's number.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } }, "304": { @@ -765962,6 +765587,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -768741,6 +768373,13 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "enum": [ @@ -897391,6 +897030,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -900498,6 +900145,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -903510,6 +903165,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -906522,6 +906185,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -909668,6 +909339,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -912821,6 +912500,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -917969,6 +917656,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -1372370,7 +1372065,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1373008,7 +1372703,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1375674,7 +1375369,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1376312,7 +1376007,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1378978,7 +1378673,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1379616,7 +1379311,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1380056,7 +1379751,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1380694,7 +1380389,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1380962,7 +1380657,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -1381600,7 +1381295,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -1381630,949 +1381325,5099 @@ ] } }, - "updated": { + "updated": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "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.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", + "items": { + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + }, + "automatic_copilot_code_review_enabled": { + "type": "boolean", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + }, + "required_reviewers": { + "type": "array", + "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", + "items": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer": { + "title": "Reviewer", + "description": "A required reviewing team", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "ID of the reviewer which must review changes to matching files." + }, + "type": { + "type": "string", + "description": "The type of the reviewer", + "enum": [ + "Team" + ] + } + }, + "required": [ + "id", + "type" + ] + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer" + ] + } + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + } + ] + }, + "changes": { + "type": "object", + "properties": { + "configuration": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "rule_type": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + }, + "pattern": { + "type": "object", + "properties": { + "from": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "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", + "repository_ruleset", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_ruleset", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "repository-transferred": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository transferred event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "transferred" + ] + }, + "changes": { + "type": "object", + "properties": { + "owner": { + "type": "object", + "properties": { + "from": { + "type": "object", + "properties": { + "organization": { + "title": "Organization", + "type": "object", + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "hooks_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "issues_url": { + "type": "string", + "format": "uri" + }, + "login": { + "type": "string" + }, + "members_url": { + "type": "string", + "format": "uri-template" + }, + "node_id": { + "type": "string" + }, + "public_members_url": { + "type": "string", + "format": "uri-template" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id", + "node_id", + "url", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { + "title": "User", + "type": [ + "object", + "null" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer", + "format": "int64" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + }, + "required": [ + "login", + "id" + ] + } + } + } + }, + "required": [ + "from" + ] + } + }, + "required": [ + "owner" + ] + }, + "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/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/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" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "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" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "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", + "changes", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-unarchived": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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/webhooks/webhook-events-and-payloads#repository" + }, + "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": "repository unarchived event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "unarchived" + ] + }, + "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/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/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" + ] + }, + "repository": { + "title": "Repository", + "description": "The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property\nwhen the event occurs from activity in a repository.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "type": "integer", + "format": "int64", + "examples": [ + 42 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "examples": [ + "Team Environment" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "license": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "mit" + ] + }, + "name": { + "type": "string", + "examples": [ + "MIT License" + ] + }, + "url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://api.github.com/licenses/mit" + ] + }, + "spdx_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "MIT" + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDc6TGljZW5zZW1pdA==" + ] + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "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" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "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": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string", + "examples": [ + "git@github.com:octocat/Hello-World.git" + ] + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string", + "examples": [ + "https://github.com/octocat/Hello-World.git" + ] + }, + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" + ] + }, + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "examples": [ + "master" + ] + }, + "open_issues_count": { + "type": "integer", + "examples": [ + 0 + ] + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "has_discussions": { + "description": "Whether discussions are enabled.", + "default": false, + "type": "boolean", + "examples": [ + true + ] + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "type": [ + "object", + "null" + ], + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "type": "object", - "properties": { - "rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "creation" - ] - } - } - }, - { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "update" - ] - }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" - ] - } - } - }, - { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "deletion" - ] - } - } - }, - { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_linear_history" - ] - } - } - }, - { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "merge_queue" - ] - }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" - ] - } - } - }, - { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_deployments" - ] - }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" - ] - } - } - }, - { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_signatures" - ] - } - } - }, - { - "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.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "pull_request" - ] - }, - "parameters": { - "type": "object", - "properties": { - "allowed_merge_methods": { - "type": "array", - "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", - "items": { - "type": "string", - "enum": [ - "merge", - "squash", - "rebase" - ] - } - }, - "automatic_copilot_code_review_enabled": { - "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." - }, - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - }, - "required_reviewers": { - "type": "array", - "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", - "items": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", - "items": { - "type": "string" - } - }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." - }, - "reviewer": { - "title": "Reviewer", - "description": "A required reviewing team", - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "ID of the reviewer which must review changes to matching files." - }, - "type": { - "type": "string", - "description": "The type of the reviewer", - "enum": [ - "Team" - ] - } - }, - "required": [ - "id", - "type" - ] - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer" - ] - } - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" - ] - } - } - }, - { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "required_status_checks" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { - "type": "string", - "description": "The status check context name that must be present on the commit." - }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" - ] - } - } - }, - { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "non_fast_forward" - ] - } - } - }, - { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_message_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "commit_author_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "committer_email_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "branch_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "tag_name_pattern" - ] - }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] - } - } - }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } - } - ] - }, - "changes": { - "type": "object", - "properties": { - "configuration": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "rule_type": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - }, - "pattern": { - "type": "object", - "properties": { - "from": { - "type": "string" - } - } - } - } - } + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_auto_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_update_branch": { + "type": "boolean" + }, + "use_squash_pr_title_as_default": { + "type": "boolean" + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_auto_merge": { + "description": "Whether to allow Auto-merge to be used on pull requests.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "allow_update_branch": { + "description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.", + "default": false, + "type": "boolean", + "examples": [ + false + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "description": "Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true + }, + "squash_merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)." + }, + "squash_merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message." + }, + "merge_commit_title": { + "type": "string", + "enum": [ + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." + }, + "merge_commit_message": { + "type": "string", + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "examples": [ + true + ] + }, + "allow_forking": { + "description": "Whether to allow forking this repo", + "type": "boolean" + }, + "web_commit_signoff_required": { + "description": "Whether to require contributors to sign off on web-based commits", + "default": false, + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:42Z\"" + ] + }, + "anonymous_access_enabled": { + "type": "boolean", + "description": "Whether anonymous git access is enabled for this repository" } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] }, "sender": { "title": "Simple User", @@ -1382745,7 +1386590,7 @@ }, "required": [ "action", - "repository_ruleset", + "repository", "sender" ] } @@ -1382760,8 +1386605,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -1382769,13 +1386615,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1382840,206 +1386686,186 @@ "content": { "application/json": { "schema": { - "title": "repository transferred event", + "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "transferred" + "create" ] }, - "changes": { + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], "properties": { - "owner": { - "type": "object", + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], "properties": { - "from": { - "type": "object", - "properties": { - "organization": { - "title": "Organization", - "type": "object", - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "hooks_url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "issues_url": { - "type": "string", - "format": "uri" - }, - "login": { - "type": "string" - }, - "members_url": { - "type": "string", - "format": "uri-template" - }, - "node_id": { - "type": "string" - }, - "public_members_url": { - "type": "string", - "format": "uri-template" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "login", - "id", - "node_id", - "url", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "title": "User", - "type": [ - "object", - "null" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer", - "format": "int64" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "user_view_type": { - "type": "string" - } - }, - "required": [ - "login", - "id" - ] - } - } + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" } - }, - "required": [ - "from" + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "open" ] } - }, - "required": [ - "owner" - ] + } }, "enterprise": { "title": "Enterprise", @@ -1384915,7 +1388741,7 @@ }, "required": [ "action", - "changes", + "alert", "repository", "sender" ] @@ -1384931,23 +1388757,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/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 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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -1385012,15 +1388836,199 @@ "content": { "application/json": { "schema": { - "title": "repository unarchived event", + "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "unarchived" + "dismiss" ] }, + "alert": { + "title": "Repository Vulnerability Alert Alert", + "description": "The security alert of the vulnerable dependency.", + "type": "object", + "required": [ + "affected_package_name", + "affected_range", + "created_at", + "dismiss_reason", + "dismissed_at", + "dismisser", + "external_identifier", + "external_reference", + "ghsa_id", + "id", + "node_id", + "number", + "severity", + "state" + ], + "properties": { + "affected_package_name": { + "type": "string" + }, + "affected_range": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "dismiss_comment": { + "type": [ + "string", + "null" + ] + }, + "dismiss_reason": { + "type": "string" + }, + "dismissed_at": { + "type": "string" + }, + "dismisser": { + "title": "User", + "type": [ + "object", + "null" + ], + "required": [ + "login", + "id" + ], + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "user_view_type": { + "type": "string" + } + } + }, + "external_identifier": { + "type": "string" + }, + "external_reference": { + "type": [ + "string", + "null" + ], + "format": "uri" + }, + "fix_reason": { + "type": "string" + }, + "fixed_at": { + "type": "string", + "format": "date-time" + }, + "fixed_in": { + "type": "string" + }, + "ghsa_id": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "integer" + }, + "severity": { + "type": "string" + }, + "state": { + "type": "string", + "enum": [ + "dismissed" + ] + } + } + }, "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/admin/overview/about-enterprise-accounts).\"", @@ -1386895,6 +1390903,7 @@ }, "required": [ "action", + "alert", "repository", "sender" ] @@ -1386910,21 +1390919,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "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", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1386991,13 +1390998,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert create event", + "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "create" + "reopen" ] }, "alert": { @@ -1389070,11 +1393077,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "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", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -1389141,13 +1393148,13 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert dismiss event", + "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "dismiss" + "resolve" ] }, "alert": { @@ -1389158,9 +1393165,6 @@ "affected_package_name", "affected_range", "created_at", - "dismiss_reason", - "dismissed_at", - "dismisser", "external_identifier", "external_reference", "ghsa_id", @@ -1389180,12 +1393184,6 @@ "created_at": { "type": "string" }, - "dismiss_comment": { - "type": [ - "string", - "null" - ] - }, "dismiss_reason": { "type": "string" }, @@ -1389285,9 +1393283,6 @@ "url": { "type": "string", "format": "uri" - }, - "user_view_type": { - "type": "string" } } }, @@ -1389329,7 +1393324,8 @@ "state": { "type": "string", "enum": [ - "dismissed" + "fixed", + "open" ] } } @@ -1391204,285 +1395200,1126 @@ "type", "url" ] - } - }, - "required": [ - "action", - "alert", - "repository", - "sender" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_vulnerability_alert", - "supported-webhook-types": [ - "repository", - "organization" - ] - } - } - }, - "repository-vulnerability-alert-reopen": { - "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", - "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "title": "repository_vulnerability_alert reopen event", - "type": "object", - "properties": { - "action": { - "type": "string", - "enum": [ - "reopen" - ] - }, - "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", - "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], - "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "dismiss_reason": { - "type": "string" - }, - "dismissed_at": { - "type": "string" - }, - "dismisser": { - "title": "User", - "type": [ - "object", - "null" - ], - "required": [ - "login", - "id" - ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" - }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - "url": { - "type": "string", - "format": "uri" - } - } - }, - "external_identifier": { - "type": "string" - }, - "external_reference": { - "type": [ - "string", - "null" - ], - "format": "uri" - }, - "fix_reason": { - "type": "string" - }, - "fixed_at": { - "type": "string", - "format": "date-time" - }, - "fixed_in": { - "type": "string" - }, - "ghsa_id": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "number": { - "type": "integer" - }, - "severity": { - "type": "string" - }, - "state": { - "type": "string", - "enum": [ - "open" - ] - } - } + } + }, + "required": [ + "action", + "alert", + "repository", + "sender" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_vulnerability_alert", + "supported-webhook-types": [ + "repository", + "organization" + ] + } + } + }, + "secret-scanning-alert-assigned": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 assigned.", + "operationId": "secret-scanning-alert/assigned", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "secret_scanning_alert assigned event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "assigned" + ] + }, + "alert": { + "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." + }, + "resolution": { + "type": [ + "string", + "null" + ], + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + 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" + ] + } + ] + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment to resolve an alert." + }, + "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).\"" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "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." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "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" + ] + } + ] + } + } + }, + "assignee": { + "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" + ] }, "enterprise": { "title": "Enterprise", @@ -1393359,8 +1398196,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1393374,21 +1398210,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-created": { "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", + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1393453,184 +1398290,856 @@ "content": { "application/json": { "schema": { - "title": "repository_vulnerability_alert resolve event", + "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolve" + "created" ] }, "alert": { - "title": "Repository Vulnerability Alert Alert", - "description": "The security alert of the vulnerable dependency.", "type": "object", - "required": [ - "affected_package_name", - "affected_range", - "created_at", - "external_identifier", - "external_reference", - "ghsa_id", - "id", - "node_id", - "number", - "severity", - "state" - ], "properties": { - "affected_package_name": { - "type": "string" - }, - "affected_range": { - "type": "string" + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true }, "created_at": { - "type": "string" + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true }, - "dismiss_reason": { - "type": "string" + "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 + } + ] }, - "dismissed_at": { - "type": "string" + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true }, - "dismisser": { - "title": "User", + "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." + }, + "resolution": { "type": [ - "object", + "string", "null" ], - "required": [ - "login", - "id" + "description": "The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + "resolved_at": { + "type": [ + "string", + "null" ], - "properties": { - "avatar_url": { - "type": "string", - "format": "uri" - }, - "deleted": { - "type": "boolean" - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "events_url": { - "type": "string", - "format": "uri-template" - }, - "followers_url": { - "type": "string", - "format": "uri" - }, - "following_url": { - "type": "string", - "format": "uri-template" - }, - "gists_url": { - "type": "string", - "format": "uri-template" - }, - "gravatar_id": { - "type": "string" - }, - "html_url": { - "type": "string", - "format": "uri" - }, - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "name": { - "type": "string" - }, - "node_id": { - "type": "string" - }, - "organizations_url": { - "type": "string", - "format": "uri" - }, - "received_events_url": { - "type": "string", - "format": "uri" - }, - "repos_url": { - "type": "string", - "format": "uri" - }, - "site_admin": { - "type": "boolean" - }, - "starred_url": { - "type": "string", - "format": "uri-template" - }, - "subscriptions_url": { - "type": "string", - "format": "uri" + "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" }, - "type": { - "type": "string", - "enum": [ - "Bot", - "User", - "Organization" + { + "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" ] - }, - "url": { - "type": "string", - "format": "uri" } - } - }, - "external_identifier": { - "type": "string" + ] }, - "external_reference": { + "resolution_comment": { "type": [ "string", "null" ], - "format": "uri" + "description": "An optional comment to resolve an alert." }, - "fix_reason": { - "type": "string" + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." }, - "fixed_at": { + "secret_type_display_name": { "type": "string", - "format": "date-time" + "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).\"" }, - "fixed_in": { - "type": "string" + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] }, - "ghsa_id": { - "type": "string" + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." }, - "id": { - "type": "integer" + "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" + ] + } + ] }, - "node_id": { - "type": "string" + "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`." }, - "number": { - "type": "integer" + "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" + ] + } + ] }, - "severity": { - "type": "string" + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." }, - "state": { - "type": "string", - "enum": [ - "fixed", - "open" + "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." + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or business." + }, + "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" + ] + } ] } } @@ -1395510,8 +1401019,7 @@ "required": [ "action", "alert", - "repository", - "sender" + "repository" ] } } @@ -1395525,21 +1401033,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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/webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -1395604,7 +1401113,7 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert created event", + "title": "Secret Scanning Alert Location Created Event", "type": "object", "properties": { "action": { @@ -1396458,96 +1401967,6 @@ } } }, - "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/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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", @@ -1396573,6 +1401992,354 @@ "node_id" ] }, + "location": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "commit", + "wiki_commit", + "issue_title", + "issue_body", + "issue_comment", + "discussion_title", + "discussion_body", + "discussion_comment", + "pull_request_title", + "pull_request_body", + "pull_request_comment", + "pull_request_review", + "pull_request_review_comment" + ], + "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "examples": [ + "commit" + ] + }, + "details": { + "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" + ] + } + ] + } + } + }, "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.", @@ -1398331,10 +1404098,185 @@ } }, "required": [ - "action", + "location", "alert", - "repository" + "repository", + "sender" + ] + }, + "examples": { + "default": { + "value": { + "action": "created", + "alert": { + "number": 42, + "created_at": "2020-11-06T18:18:30Z", + "updated_at": "2020-11-06T18:18:30Z", + "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", + "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", + "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", + "state": "open", + "resolution": null, + "resolved_at": null, + "resolved_by": null, + "secret_type": "mailchimp_api_key", + "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", + "publicly_leaked": false, + "multi_repo": false + }, + "location": { + "type": "commit", + "details": { + "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + } + }, + "repository": { + "id": 186853002, + "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", + "name": "hello-world", + "full_name": "octocat-repo/hello-world", + "private": false, + "owner": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + }, + "html_url": "https://github.com/octocat-repo/hello-world", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octocat-repo/hello-world", + "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", + "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", + "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", + "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", + "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", + "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", + "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", + "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", + "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", + "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", + "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", + "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", + "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", + "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", + "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", + "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", + "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", + "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", + "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", + "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", + "created_at": "2019-05-15T15:19:25Z", + "updated_at": "2019-05-15T15:21:03Z", + "pushed_at": "2019-05-15T15:20:57Z", + "git_url": "git://github.com/octocat-repo/hello-world.git", + "ssh_url": "git@github.com:octocat-repo/hello-world.git", + "clone_url": "https://github.com/octocat-repo/hello-world.git", + "svn_url": "https://github.com/octocat-repo/hello-world", + "homepage": null, + "size": 0, + "stargazers_count": 0, + "watchers_count": 0, + "language": "Ruby", + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": true, + "forks_count": 1, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 2, + "license": null, + "forks": 1, + "open_issues": 2, + "watchers": 0, + "default_branch": "master", + "is_template": false + }, + "sender": { + "login": "octocat", + "id": 21031067, + "node_id": "MDQ6VXNlcjIxMDMxMDY3", + "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", + "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 + } + } + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "title": "Secret Scanning Alert Location Created Event", + "type": "object", + "properties": { + "payload": { + "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", + "type": "string" + } + }, + "required": [ + "payload" ] + }, + "examples": { + "default": { + "value": { + "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" + } + } } } } @@ -1398346,8 +1404288,9 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", "organization", @@ -1398356,13 +1404299,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-publicly-leaked": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", "externalDocs": { - "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -1398427,13 +1404370,13 @@ "content": { "application/json": { "schema": { - "title": "Secret Scanning Alert Location Created Event", + "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "created" + "publicly_leaked" ] }, "alert": { @@ -1399281,378 +1405224,120 @@ } } }, - "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "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/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": "The ID of the installation.", + "description": "Unique identifier of the enterprise", "type": "integer", "examples": [ - 1 + 42 ] }, "node_id": { - "description": "The global node ID of the installation.", "type": "string", "examples": [ - "MDQ6VXNlcjU4MzIzMQ==" + "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" + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" ] }, - "location": { + "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/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "commit", - "wiki_commit", - "issue_title", - "issue_body", - "issue_comment", - "discussion_title", - "discussion_body", - "discussion_comment", - "pull_request_title", - "pull_request_body", - "pull_request_comment", - "pull_request_review", - "pull_request_review_comment" - ], - "description": "The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.", + "id": { + "description": "The ID of the installation.", + "type": "integer", "examples": [ - "commit" + 1 ] }, - "details": { - "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" - ] - } + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "examples": [ + "MDQ6VXNlcjU4MzIzMQ==" ] } - } + }, + "required": [ + "id", + "node_id" + ] }, "organization": { "title": "Organization Simple", @@ -1401412,185 +1407097,10 @@ } }, "required": [ - "location", + "action", "alert", - "repository", - "sender" - ] - }, - "examples": { - "default": { - "value": { - "action": "created", - "alert": { - "number": 42, - "created_at": "2020-11-06T18:18:30Z", - "updated_at": "2020-11-06T18:18:30Z", - "url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42", - "html_url": "https://github.com/octocat-repo/hello-world/security/secret-scanning/42", - "locations_url": "https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations", - "state": "open", - "resolution": null, - "resolved_at": null, - "resolved_by": null, - "secret_type": "mailchimp_api_key", - "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", - "publicly_leaked": false, - "multi_repo": false - }, - "location": { - "type": "commit", - "details": { - "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-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", - "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", - "commit_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" - } - }, - "repository": { - "id": 186853002, - "node_id": "MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI=", - "name": "hello-world", - "full_name": "octocat-repo/hello-world", - "private": false, - "owner": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - }, - "html_url": "https://github.com/octocat-repo/hello-world", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/octocat-repo/hello-world", - "forks_url": "https://api.github.com/repos/octocat-repo/hello-world/forks", - "keys_url": "https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/octocat-repo/hello-world/teams", - "hooks_url": "https://api.github.com/repos/octocat-repo/hello-world/hooks", - "issue_events_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number}", - "events_url": "https://api.github.com/repos/octocat-repo/hello-world/events", - "assignees_url": "https://api.github.com/repos/octocat-repo/hello-world/assignees{/user}", - "branches_url": "https://api.github.com/repos/octocat-repo/hello-world/branches{/branch}", - "tags_url": "https://api.github.com/repos/octocat-repo/hello-world/tags", - "blobs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha}", - "languages_url": "https://api.github.com/repos/octocat-repo/hello-world/languages", - "stargazers_url": "https://api.github.com/repos/octocat-repo/hello-world/stargazers", - "contributors_url": "https://api.github.com/repos/octocat-repo/hello-world/contributors", - "subscribers_url": "https://api.github.com/repos/octocat-repo/hello-world/subscribers", - "subscription_url": "https://api.github.com/repos/octocat-repo/hello-world/subscription", - "commits_url": "https://api.github.com/repos/octocat-repo/hello-world/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/octocat-repo/hello-world/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/octocat-repo/hello-world/contents/{+path}", - "compare_url": "https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/octocat-repo/hello-world/merges", - "archive_url": "https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/octocat-repo/hello-world/downloads", - "issues_url": "https://api.github.com/repos/octocat-repo/hello-world/issues{/number}", - "pulls_url": "https://api.github.com/repos/octocat-repo/hello-world/pulls{/number}", - "milestones_url": "https://api.github.com/repos/octocat-repo/hello-world/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/octocat-repo/hello-world/labels{/name}", - "releases_url": "https://api.github.com/repos/octocat-repo/hello-world/releases{/id}", - "deployments_url": "https://api.github.com/repos/octocat-repo/hello-world/deployments", - "created_at": "2019-05-15T15:19:25Z", - "updated_at": "2019-05-15T15:21:03Z", - "pushed_at": "2019-05-15T15:20:57Z", - "git_url": "git://github.com/octocat-repo/hello-world.git", - "ssh_url": "git@github.com:octocat-repo/hello-world.git", - "clone_url": "https://github.com/octocat-repo/hello-world.git", - "svn_url": "https://github.com/octocat-repo/hello-world", - "homepage": null, - "size": 0, - "stargazers_count": 0, - "watchers_count": 0, - "language": "Ruby", - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": true, - "forks_count": 1, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 2, - "license": null, - "forks": 1, - "open_issues": 2, - "watchers": 0, - "default_branch": "master", - "is_template": false - }, - "sender": { - "login": "octocat", - "id": 21031067, - "node_id": "MDQ6VXNlcjIxMDMxMDY3", - "avatar_url": "https://avatars1.githubusercontent.com/u/21031067?v=4", - "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 - } - } - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "title": "Secret Scanning Alert Location Created Event", - "type": "object", - "properties": { - "payload": { - "description": "A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object.", - "type": "string" - } - }, - "required": [ - "payload" + "repository" ] - }, - "examples": { - "default": { - "value": { - "payload": "action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A" - } - } } } } @@ -1401602,9 +1407112,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -1401613,11 +1407122,11 @@ } } }, - "secret-scanning-alert-publicly-leaked": { + "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1401684,13 +1407193,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert publicly leaked event", + "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "publicly_leaked" + "reopened" ] }, "alert": { @@ -1404436,11 +1409945,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-resolved": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1404507,13 +1410016,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert reopened event", + "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "reopened" + "resolved" ] }, "alert": { @@ -1407259,11 +1412768,11 @@ } } }, - "secret-scanning-alert-resolved": { + "secret-scanning-alert-unassigned": { "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/code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/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 unassigned.", + "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -1407330,13 +1412839,13 @@ "content": { "application/json": { "schema": { - "title": "secret_scanning_alert resolved event", + "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": [ - "resolved" + "unassigned" ] }, "alert": { @@ -1408184,6 +1413693,174 @@ } } }, + "assignee": { + "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" + ] + }, "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/admin/overview/about-enterprise-accounts).\"", 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 0fb62e763..69c335667 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 @@ -57,8 +57,6 @@ tags: description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects-classic - description: Interact with GitHub Projects (classic). - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit @@ -440,7 +438,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &38 + - &43 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 @@ -449,7 +447,7 @@ paths: required: false schema: type: string - - &39 + - &44 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 @@ -458,7 +456,7 @@ paths: required: false schema: type: string - - &46 + - &50 name: direction description: The direction to sort the results by. in: query @@ -697,7 +695,7 @@ paths: required: - vector_string - score - cvss_severities: &48 + cvss_severities: &52 type: - object - 'null' @@ -744,7 +742,7 @@ paths: required: - vector_string - score - epss: &49 + epss: &53 type: - object - 'null' @@ -907,7 +905,7 @@ paths: - subscriptions_url - type - url - type: &289 + type: &296 type: string description: The type of credit the user is receiving. enum: @@ -1040,7 +1038,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &106 + schema: &112 title: Validation Error Simple description: Validation Error Simple type: object @@ -1073,7 +1071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &613 + - &617 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1658,7 +1656,7 @@ paths: schema: type: integer default: 30 - - &186 + - &192 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 @@ -1674,7 +1672,7 @@ paths: application/json: schema: type: array - items: &187 + items: &193 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1770,7 +1768,7 @@ paths: - installation_id - repository_id examples: - default: &188 + default: &194 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1833,7 +1831,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &105 + schema: &111 title: Validation Error description: Validation Error type: object @@ -1905,7 +1903,7 @@ paths: description: Response content: application/json: - schema: &189 + schema: &195 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -2040,7 +2038,7 @@ paths: - request - response examples: - default: &190 + default: &196 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2244,7 +2242,7 @@ paths: parameters: - *17 - *19 - - &68 + - &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) @@ -2343,6 +2341,13 @@ paths: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access + token to create and retrieve build artifact metadata records. + enum: + - read + - write attestations: type: string description: The level of permission to create and retrieve @@ -2832,7 +2837,7 @@ paths: suspended_at: suspended_by: headers: - Link: &52 + Link: &56 example: ; rel="next", ; rel="last" schema: @@ -3022,7 +3027,7 @@ paths: - selected repositories: type: array - items: &64 + items: &68 title: Repository description: A repository on GitHub. type: object @@ -3049,7 +3054,7 @@ paths: license: anyOf: - type: 'null' - - &79 + - &83 title: License Simple description: License Simple type: object @@ -5427,7 +5432,7 @@ paths: responses: '202': *37 '422': *7 - '500': &96 + '500': &102 description: Internal Error content: application/json: @@ -7342,6 +7347,166 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - &38 + 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: &39 + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, + the maximum duration, in days, for which caches in a repository + may be retained. + type: integer + examples: + - 14 + examples: + default: &40 + value: + max_cache_retention_days: 80 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - *38 + requestBody: + required: true + content: + application/json: + schema: *39 + examples: + selected_actions: *40 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *38 + responses: + '200': + description: Response + content: + application/json: + schema: &41 + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, + the maximum size limit for the sum of all caches in a repository, + in gigabytes. + type: integer + examples: + - 10 + examples: + default: &42 + value: + max_cache_size_gb: 150 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - *38 + requestBody: + required: true + content: + application/json: + schema: *41 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise @@ -7358,13 +7523,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise parameters: - - &40 - name: enterprise - description: The slug version of the enterprise name. - in: path - required: true - schema: - type: string + - *38 - name: per_page in: query description: The number of results per page (max 100). For more information, @@ -7373,8 +7532,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -7382,7 +7541,7 @@ paths: application/json: schema: type: array - items: &41 + items: &45 type: object description: A code security configuration properties: @@ -7679,7 +7838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise parameters: - - *40 + - *38 requestBody: required: true content: @@ -7757,7 +7916,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: &164 + code_scanning_options: &170 type: - object - 'null' @@ -7776,7 +7935,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &44 + code_scanning_default_setup_options: &48 type: - object - 'null' @@ -7895,9 +8054,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *41 + schema: *45 examples: - default: &42 + default: &46 value: id: 1325 target_type: enterprise @@ -7949,13 +8108,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise parameters: - - *40 + - *38 responses: '200': description: Response content: application/json: - schema: &166 + schema: &172 type: array description: A list of default code security configurations items: @@ -7969,9 +8128,9 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *41 + configuration: *45 examples: - default: &167 + default: &173 value: - default_for_new_repos: public configuration: @@ -8059,8 +8218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise parameters: - - *40 - - &43 + - *38 + - &47 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -8072,9 +8231,9 @@ paths: description: Response content: application/json: - schema: *41 + schema: *45 examples: - default: *42 + default: *46 '304': *35 '403': *27 '404': *6 @@ -8098,8 +8257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise parameters: - - *40 - - *43 + - *38 + - *47 requestBody: required: true content: @@ -8178,7 +8337,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *44 + code_scanning_default_setup_options: *48 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -8266,13 +8425,13 @@ paths: description: Response content: application/json: - schema: *41 + schema: *45 examples: - default: *42 + default: *46 '304': *35 '403': *27 '404': *6 - '409': &45 + '409': &49 description: Conflict content: application/json: @@ -8299,15 +8458,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise parameters: - - *40 - - *43 + - *38 + - *47 responses: - '204': &168 + '204': &174 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -8331,8 +8490,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories parameters: - - *40 - - *43 + - *38 + - *47 requestBody: required: true content: @@ -8359,7 +8518,7 @@ paths: '202': *37 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -8383,8 +8542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise parameters: - - *40 - - *43 + - *38 + - *47 requestBody: required: true content: @@ -8424,12 +8583,12 @@ paths: - none - private_and_internal - public - configuration: *41 + configuration: *45 examples: default: value: default_for_new_repos: all - configuration: &165 + configuration: &171 value: id: 1325 target_type: organization @@ -8485,8 +8644,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration parameters: - - *40 - - *43 + - *38 + - *47 - 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)." @@ -8495,8 +8654,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -8514,7 +8673,7 @@ paths: application/json: schema: type: array - items: &169 + items: &175 type: object description: Repositories associated with a code security configuration and attachment status @@ -8532,7 +8691,7 @@ paths: - failed - updating - removed_by_enterprise - repository: &51 + repository: &55 title: Simple Repository description: A GitHub repository. type: object @@ -8859,7 +9018,7 @@ paths: summary: Example of code security configuration repositories value: - status: attached - repository: &170 + repository: &176 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -8952,8 +9111,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *40 - - &173 + - *38 + - &179 name: state in: query description: |- @@ -8962,7 +9121,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &174 + - &180 name: severity in: query description: |- @@ -8971,7 +9130,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &175 + - &181 name: ecosystem in: query description: |- @@ -8980,14 +9139,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &176 + - &182 name: package in: query description: A comma-separated list of package names. If specified, only alerts for these packages will be returned. schema: type: string - - &177 + - &183 name: epss_percentage in: query description: |- @@ -8999,7 +9158,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 - - &454 + - &458 name: has in: query description: |- @@ -9013,7 +9172,7 @@ paths: type: string enum: - patch - - &178 + - &184 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -9023,7 +9182,7 @@ paths: enum: - development - runtime - - &179 + - &185 name: sort in: query description: |- @@ -9038,9 +9197,9 @@ paths: - updated - epss_percentage default: created - - *46 - - *38 - - *39 + - *50 + - *43 + - *44 - *17 responses: '200': @@ -9049,11 +9208,11 @@ paths: application/json: schema: type: array - items: &180 + items: &186 type: object description: A Dependabot alert. properties: - number: &154 + number: &160 type: integer description: The security alert number. readOnly: true @@ -9071,7 +9230,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &47 + package: &51 type: object description: Details for the vulnerable package. readOnly: true @@ -9119,7 +9278,7 @@ paths: - direct - transitive - - security_advisory: &455 + security_advisory: &459 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -9150,13 +9309,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &50 + items: &54 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *47 + package: *51 severity: type: string description: The severity of the vulnerability. @@ -9224,8 +9383,8 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *48 - epss: *49 + cvss_severities: *52 + epss: *53 cwes: type: array description: Details for the advisory pertaining to Common @@ -9325,30 +9484,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *50 - url: &157 + security_vulnerability: *54 + url: &163 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &158 + html_url: &164 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &155 + created_at: &161 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: &156 + updated_at: &162 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: &160 + dismissed_at: &166 type: - string - 'null' @@ -9379,7 +9538,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &159 + fixed_at: &165 type: - string - 'null' @@ -9387,7 +9546,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &456 + auto_dismissed_at: &460 type: - string - 'null' @@ -9395,7 +9554,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - repository: *51 + repository: *55 required: - number - state @@ -9414,7 +9573,7 @@ paths: - repository additionalProperties: false examples: - default: &181 + default: &187 value: - number: 2 state: dismissed @@ -9753,7 +9912,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - - *40 + - *38 - *17 - *19 responses: @@ -9763,7 +9922,7 @@ paths: application/json: schema: type: array - items: &53 + items: &57 title: Enterprise Team description: Group of enterprise owners and/or members type: object @@ -9828,7 +9987,7 @@ paths: - updated_at - group_id examples: - default: &54 + default: &58 value: - id: 1 name: Justice League @@ -9841,7 +10000,7 @@ paths: created_at: '2019-01-26T19:01:12Z' updated_at: '2019-01-26T19:14:43Z' headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -9859,7 +10018,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team parameters: - - *40 + - *38 requestBody: required: true content: @@ -9916,9 +10075,9 @@ paths: description: Response content: application/json: - schema: *53 + schema: *57 examples: - default: *54 + default: *58 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9935,8 +10094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team parameters: - - *40 - - &55 + - *38 + - &59 name: enterprise-team description: The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. @@ -9955,7 +10114,7 @@ paths: type: array items: *4 examples: - default: &56 + default: &60 value: - login: octocat id: 1 @@ -9976,7 +10135,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -9993,8 +10152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10025,7 +10184,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10042,8 +10201,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10074,7 +10233,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10091,9 +10250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership parameters: - - *40 - - *55 - - &57 + - *38 + - *59 + - &61 name: username description: The handle for the GitHub user account. in: path @@ -10107,7 +10266,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: &58 + exampleKey1: &62 value: login: octocat id: 1 @@ -10142,9 +10301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member parameters: - - *40 - - *55 - - *57 + - *38 + - *59 + - *61 responses: '201': description: Successfully added team member @@ -10152,7 +10311,7 @@ paths: application/json: schema: *4 examples: - exampleKey1: *58 + exampleKey1: *62 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10169,9 +10328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership parameters: - - *40 - - *55 - - *57 + - *38 + - *59 + - *61 responses: '204': description: Response @@ -10192,8 +10351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments parameters: - - *40 - - *55 + - *38 + - *59 - *17 - *19 responses: @@ -10203,7 +10362,7 @@ paths: application/json: schema: type: array - items: &59 + items: &63 title: Organization Simple description: A GitHub organization. type: object @@ -10275,7 +10434,7 @@ paths: - avatar_url - description examples: - default: &60 + default: &64 value: login: github id: 1 @@ -10305,8 +10464,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10334,9 +10493,9 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: &94 + default: &98 value: - login: github id: 1 @@ -10366,8 +10525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments parameters: - - *40 - - *55 + - *38 + - *59 requestBody: required: true content: @@ -10407,9 +10566,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment parameters: - - *40 - - *55 - - &61 + - *38 + - *59 + - &65 name: org description: The organization name. The name is not case sensitive. in: path @@ -10421,9 +10580,9 @@ paths: description: The team is assigned to the organization content: application/json: - schema: *59 + schema: *63 examples: - default: *60 + default: *64 '404': description: The team is not assigned to the organization x-github: @@ -10441,17 +10600,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment parameters: - - *40 - - *55 - - *61 + - *38 + - *59 + - *65 responses: '201': description: Successfully assigned the enterprise team to the organization. content: application/json: - schema: *59 + schema: *63 examples: - default: *60 + default: *64 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -10467,9 +10626,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment parameters: - - *40 - - *55 - - *61 + - *38 + - *59 + - *65 responses: '204': description: Successfully unassigned the enterprise team from the organization. @@ -10492,8 +10651,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team parameters: - - *40 - - &62 + - *38 + - &66 name: team_slug description: The slug of the team name. in: path @@ -10505,11 +10664,11 @@ paths: description: Response content: application/json: - schema: *53 + schema: *57 examples: - default: *54 + default: *58 headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -10526,8 +10685,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team parameters: - - *40 - - *62 + - *38 + - *66 requestBody: required: true content: @@ -10585,11 +10744,11 @@ paths: description: Response content: application/json: - schema: *53 + schema: *57 examples: - default: *54 + default: *58 headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -10609,8 +10768,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team parameters: - - *40 - - *62 + - *38 + - *66 responses: '204': description: Response @@ -10648,7 +10807,7 @@ paths: application/json: schema: type: array - items: &89 + items: &93 title: Event description: Event type: object @@ -10659,7 +10818,7 @@ paths: type: - string - 'null' - actor: &63 + actor: &67 title: Actor description: Actor type: object @@ -10700,13 +10859,13 @@ paths: - id - name - url - org: *63 + org: *67 payload: type: object properties: action: type: string - issue: &78 + issue: &82 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -10827,7 +10986,7 @@ paths: milestone: anyOf: - type: 'null' - - &244 + - &250 title: Milestone description: A collection of related issues and pull requests. @@ -10999,7 +11158,7 @@ paths: timeline_url: type: string format: uri - type: &208 + type: &214 title: Issue Type description: The type of issue. type: @@ -11052,12 +11211,12 @@ paths: - node_id - name - description - repository: *64 + repository: *68 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &65 + author_association: &69 title: author_association type: string description: How the author is associated with the repository. @@ -11072,7 +11231,7 @@ paths: - OWNER examples: - OWNER - reactions: &66 + reactions: &70 title: Reaction Rollup type: object properties: @@ -11108,7 +11267,7 @@ paths: - hooray - eyes - rocket - sub_issues_summary: &625 + sub_issues_summary: &629 title: Sub-issues Summary type: object properties: @@ -11129,7 +11288,7 @@ paths: - string - 'null' format: uri - issue_dependencies_summary: &626 + issue_dependencies_summary: &630 title: Issue Dependencies Summary type: object properties: @@ -11148,7 +11307,7 @@ paths: - total_blocking issue_field_values: type: array - items: &627 + items: &631 title: Issue Field Value description: A value assigned to an issue field type: object @@ -11243,7 +11402,7 @@ paths: - user - created_at - updated_at - comment: &503 + comment: &507 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -11293,12 +11452,12 @@ paths: issue_url: type: string format: uri - author_association: *65 + author_association: *69 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *66 + reactions: *70 required: - id - node_id @@ -11386,7 +11545,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': &97 + '503': &103 description: Service unavailable content: application/json: @@ -11488,7 +11647,7 @@ paths: _links: type: object properties: - timeline: &67 + timeline: &71 title: Link With Type description: Hypermedia Link with Type type: object @@ -11500,17 +11659,17 @@ paths: required: - href - type - user: *67 - security_advisories: *67 - current_user: *67 - current_user_public: *67 - current_user_actor: *67 - current_user_organization: *67 + 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: *67 - repository_discussions: *67 - repository_discussions_category: *67 + items: *71 + repository_discussions: *71 + repository_discussions_category: *71 required: - timeline - user @@ -11572,7 +11731,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *68 + - *72 - *17 - *19 responses: @@ -11582,7 +11741,7 @@ paths: application/json: schema: type: array - items: &69 + items: &73 title: Base Gist description: Base Gist type: object @@ -11679,7 +11838,7 @@ paths: - created_at - updated_at examples: - default: &70 + default: &74 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -11724,7 +11883,7 @@ paths: site_admin: false truncated: false headers: - Link: *52 + Link: *56 '304': *35 '403': *27 x-github: @@ -11803,7 +11962,7 @@ paths: description: Response content: application/json: - schema: &71 + schema: &75 title: Gist Simple description: Gist Simple type: object @@ -11821,7 +11980,7 @@ paths: url: type: string format: uri - user: &639 + user: &641 title: Public User description: Public User type: object @@ -12195,7 +12354,7 @@ paths: truncated: type: boolean examples: - default: &72 + default: &76 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -12299,7 +12458,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *68 + - *72 - *17 - *19 responses: @@ -12309,11 +12468,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *70 + default: *74 headers: - Link: *52 + Link: *56 '422': *15 '304': *35 '403': *27 @@ -12333,7 +12492,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *68 + - *72 - *17 - *19 responses: @@ -12343,11 +12502,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *70 + default: *74 headers: - Link: *52 + Link: *56 '401': *23 '304': *35 '403': *27 @@ -12373,7 +12532,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &73 + - &77 name: gist_id description: The unique identifier of the gist. in: path @@ -12385,10 +12544,10 @@ paths: description: Response content: application/json: - schema: *71 + schema: *75 examples: - default: *72 - '403': &76 + default: *76 + '403': &80 description: Forbidden Gist content: application/json: @@ -12437,7 +12596,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *73 + - *77 requestBody: required: true content: @@ -12501,9 +12660,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *75 examples: - updateGist: *72 + updateGist: *76 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -12661,7 +12820,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *73 + - *77 responses: '204': description: Response @@ -12690,7 +12849,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *73 + - *77 - *17 - *19 responses: @@ -12700,7 +12859,7 @@ paths: application/json: schema: type: array - items: &74 + items: &78 title: Gist Comment description: A comment made to a gist. type: object @@ -12738,7 +12897,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *65 + author_association: *69 required: - url - id @@ -12778,7 +12937,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -12803,7 +12962,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *73 + - *77 requestBody: required: true content: @@ -12829,9 +12988,9 @@ paths: description: Response content: application/json: - schema: *74 + schema: *78 examples: - default: &75 + default: &79 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -12889,8 +13048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *73 - - &77 + - *77 + - &81 name: comment_id description: The unique identifier of the comment. in: path @@ -12903,12 +13062,12 @@ paths: description: Response content: application/json: - schema: *74 + schema: *78 examples: - default: *75 + default: *79 '304': *35 '404': *6 - '403': *76 + '403': *80 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12930,8 +13089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *73 - *77 + - *81 requestBody: required: true content: @@ -12957,9 +13116,9 @@ paths: description: Response content: application/json: - schema: *74 + schema: *78 examples: - default: *75 + default: *79 '404': *6 x-github: githubCloudOnly: false @@ -12976,8 +13135,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *73 - *77 + - *81 responses: '204': description: Response @@ -13000,7 +13159,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *73 + - *77 - *17 - *19 responses: @@ -13101,7 +13260,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *73 + - *77 - *17 - *19 responses: @@ -13111,7 +13270,7 @@ paths: application/json: schema: type: array - items: *71 + items: *75 examples: default: value: @@ -13157,7 +13316,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '404': *6 '304': *35 '403': *27 @@ -13176,13 +13335,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *73 + - *77 responses: '201': description: Response content: application/json: - schema: *69 + schema: *73 examples: default: value: @@ -13253,7 +13412,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *73 + - *77 responses: '204': description: Response if gist is starred @@ -13283,7 +13442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *73 + - *77 responses: '204': description: Response @@ -13305,7 +13464,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *73 + - *77 responses: '204': description: Response @@ -13334,7 +13493,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *73 + - *77 - name: sha in: path required: true @@ -13345,9 +13504,9 @@ paths: description: Response content: application/json: - schema: *71 + schema: *75 examples: - default: *72 + default: *76 '422': *15 '404': *6 '403': *27 @@ -13508,7 +13667,7 @@ paths: type: integer repositories: type: array - items: *64 + items: *68 repository_selection: type: string examples: @@ -13632,7 +13791,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *52 + Link: *56 '403': *27 '304': *35 '401': *23 @@ -13716,7 +13875,7 @@ paths: - closed - all default: open - - &211 + - &217 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13734,8 +13893,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - name: collab in: query required: false @@ -13765,9 +13924,9 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: &212 + default: &218 value: - id: 1 node_id: MDU6SXNzdWUx @@ -14011,7 +14170,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *52 + Link: *56 '422': *15 '304': *35 '404': *6 @@ -14046,7 +14205,7 @@ paths: application/json: schema: type: array - items: *79 + items: *83 examples: default: value: @@ -14344,7 +14503,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &80 + X-CommonMarker-Version: &84 example: 0.17.4 schema: type: string @@ -14399,7 +14558,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *80 + X-CommonMarker-Version: *84 content: text/html: schema: @@ -14428,7 +14587,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &83 + - &87 name: account_id description: account_id parameter in: path @@ -14440,7 +14599,7 @@ paths: description: Response content: application/json: - schema: &82 + schema: &86 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -14474,7 +14633,7 @@ paths: - 'null' id: type: integer - plan: &81 + plan: &85 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -14577,7 +14736,7 @@ paths: - 'null' updated_at: type: string - plan: *81 + plan: *85 required: - url - id @@ -14585,7 +14744,7 @@ paths: - login - marketplace_purchase examples: - default: &84 + default: &88 value: url: https://api.github.com/orgs/github type: Organization @@ -14670,9 +14829,9 @@ paths: application/json: schema: type: array - items: *81 + items: *85 examples: - default: &85 + default: &89 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -14690,7 +14849,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *52 + Link: *56 '404': *6 '401': *23 x-github: @@ -14712,14 +14871,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &86 + - &90 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &87 + - &91 name: sort description: The property to sort the results by. in: query @@ -14749,9 +14908,9 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: &88 + default: &92 value: - url: https://api.github.com/orgs/github type: Organization @@ -14802,7 +14961,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *52 + Link: *56 '404': *6 '422': *15 '401': *23 @@ -14825,15 +14984,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *83 + - *87 responses: '200': description: Response content: application/json: - schema: *82 + schema: *86 examples: - default: *84 + default: *88 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -14865,11 +15024,11 @@ paths: application/json: schema: type: array - items: *81 + items: *85 examples: - default: *85 + default: *89 headers: - Link: *52 + Link: *56 '401': *23 x-github: githubCloudOnly: false @@ -14890,8 +15049,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *86 - - *87 + - *90 + - *91 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -14911,11 +15070,11 @@ paths: application/json: schema: type: array - items: *82 + items: *86 examples: - default: *88 + default: *92 headers: - Link: *52 + Link: *56 '401': *23 x-github: githubCloudOnly: false @@ -15178,14 +15337,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &311 + - &316 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &312 + - &317 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -15202,7 +15361,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -15247,7 +15406,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &318 + '301': &320 description: Moved permanently content: application/json: @@ -15269,7 +15428,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &532 + - &536 name: all description: If `true`, show notifications marked as read. in: query @@ -15277,7 +15436,7 @@ paths: schema: type: boolean default: false - - &533 + - &537 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -15286,8 +15445,8 @@ paths: schema: type: boolean default: false - - *68 - - &534 + - *72 + - &538 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: @@ -15312,14 +15471,14 @@ paths: application/json: schema: type: array - items: &90 + items: &94 title: Thread description: Thread type: object properties: id: type: string - repository: &136 + repository: &142 title: Minimal Repository description: Minimal Repository type: object @@ -15658,7 +15817,7 @@ paths: type: boolean examples: - false - security_and_analysis: &257 + security_and_analysis: &263 type: - object - 'null' @@ -15823,7 +15982,7 @@ paths: - url - subscription_url examples: - default: &535 + default: &539 value: - id: '1' repository: @@ -15905,7 +16064,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -15989,7 +16148,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &91 + - &95 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 @@ -16003,7 +16162,7 @@ paths: description: Response content: application/json: - schema: *90 + schema: *94 examples: default: value: @@ -16105,7 +16264,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *91 + - *95 responses: '205': description: Reset Content @@ -16127,7 +16286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *91 + - *95 responses: '204': description: No content @@ -16150,13 +16309,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *91 + - *95 responses: '200': description: Response content: application/json: - schema: &92 + schema: &96 title: Thread Subscription description: Thread Subscription type: object @@ -16200,7 +16359,7 @@ paths: - url - subscribed examples: - default: &93 + default: &97 value: subscribed: true ignored: false @@ -16231,7 +16390,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *91 + - *95 requestBody: required: false content: @@ -16252,9 +16411,9 @@ paths: description: Response content: application/json: - schema: *92 + schema: *96 examples: - default: *93 + default: *97 '304': *35 '403': *27 '401': *23 @@ -16277,7 +16436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *91 + - *95 responses: '204': description: Response @@ -16372,9 +16531,9 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: *94 + default: *98 headers: Link: example: ; rel="next" @@ -16386,6 +16545,154 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - *65 + responses: + '200': + description: Response + content: + application/json: + schema: &99 + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: For repositories in this organization, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + examples: + default: *40 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - *65 + requestBody: + required: true + content: + application/json: + schema: *99 + examples: + selected_actions: *40 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - *65 + responses: + '200': + description: Response + content: + application/json: + schema: &100 + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum + size limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 + examples: + default: *42 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - *65 + requestBody: + required: true + content: + application/json: + schema: *100 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/organizations/{org}/dependabot/repository-access": get: summary: Lists the repositories Dependabot can access in an organization @@ -16401,7 +16708,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: - - *61 + - *65 - name: page in: query description: The page number of results to fetch. @@ -16447,7 +16754,7 @@ paths: items: anyOf: - type: 'null' - - *51 + - *55 additionalProperties: false examples: default: @@ -16552,7 +16859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -16618,7 +16925,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot parameters: - - *61 + - *65 requestBody: required: true content: @@ -16671,7 +16978,7 @@ paths: 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 + - *65 responses: '200': description: Response @@ -16679,7 +16986,7 @@ paths: application/json: schema: type: array - items: &95 + items: &101 title: Custom Property Value description: Custom property name and associated value type: object @@ -16702,7 +17009,7 @@ paths: - property_name - value examples: - default: &541 + default: &545 value: - property_name: environment value: production @@ -16736,7 +17043,7 @@ paths: 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 + - *65 requestBody: required: true content: @@ -16748,11 +17055,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the organization. - items: *95 + items: *101 required: - properties examples: - default: &542 + default: &546 value: properties: - property_name: environment @@ -16788,7 +17095,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization parameters: - - *61 + - *65 + - *19 + - *17 + - name: page_size + description: The number of results per page (max 10). + in: query + schema: + type: integer + default: 10 + - name: scope + description: Filter budgets by scope type. + in: query + schema: + type: string + enum: + - enterprise + - organization + - repository + - cost-center responses: '200': description: Response when getting all budgets @@ -16870,6 +17195,10 @@ paths: - prevent_further_usage - budget_alerting description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available + (maps to hasNextPage from billing platform) required: - budgets examples: @@ -16911,7 +17240,7 @@ paths: alert_recipients: [] '404': *6 '403': *27 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16932,8 +17261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization parameters: - - *61 - - &98 + - *65 + - &104 name: budget_id description: The ID corresponding to the budget. in: path @@ -17032,8 +17361,8 @@ paths: '400': *14 '404': *6 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17053,8 +17382,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization parameters: - - *61 - - *98 + - *65 + - *104 requestBody: required: true content: @@ -17179,7 +17508,19 @@ paths: update-budget: value: message: Budget successfully updated. - id: 550e8400-e29b-41d4-a716-446655440000 + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa '400': *14 '401': *23 '403': *27 @@ -17228,8 +17569,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization parameters: - - *61 - - *98 + - *65 + - *104 responses: '200': description: Response when deleting a budget @@ -17255,8 +17596,8 @@ paths: '400': *14 '404': *6 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17276,8 +17617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization parameters: - - *61 - - &99 + - *65 + - &105 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, @@ -17286,7 +17627,7 @@ paths: required: false schema: type: integer - - &101 + - &107 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 @@ -17295,7 +17636,7 @@ paths: required: false schema: type: integer - - &100 + - &106 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 @@ -17310,14 +17651,14 @@ paths: required: false schema: type: string - - &677 + - &688 name: model description: The model name to query usage for. The name is not case sensitive. in: query required: false schema: type: string - - &102 + - &108 name: product description: The product name to query usage for. The name is not case sensitive. in: query @@ -17433,8 +17774,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17454,9 +17795,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - - *61 - - *99 - - &678 + - *65 + - *105 + - &689 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 @@ -17465,7 +17806,7 @@ paths: required: false schema: type: integer - - *100 + - *106 responses: '200': description: Billing usage report response for an organization @@ -17540,8 +17881,8 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17564,19 +17905,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization parameters: - - *61 - - *99 - - *101 - - *100 - - &679 + - *65 + - *105 + - *107 + - *106 + - &690 name: repository description: The repository name to query for usage in the format owner/repository. in: query required: false schema: type: string - - *102 - - &680 + - *108 + - &691 name: sku description: The SKU to query for usage. in: query @@ -17686,8 +18027,8 @@ paths: netAmount: 8.0 '400': *14 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17713,13 +18054,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &103 + schema: &109 title: Organization Full description: Organization Full type: object @@ -18114,7 +18455,7 @@ paths: - updated_at - archived_at examples: - default-response: &104 + default-response: &110 value: login: github id: 1 @@ -18214,7 +18555,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *61 + - *65 requestBody: required: false content: @@ -18431,18 +18772,18 @@ paths: description: Response content: application/json: - schema: *103 + schema: *109 examples: - default: *104 + default: *110 '422': description: Validation failed content: application/json: schema: oneOf: - - *105 - - *106 - '409': *45 + - *111 + - *112 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18465,7 +18806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *61 + - *65 responses: '202': *37 '404': *6 @@ -18490,7 +18831,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -18516,7 +18857,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18537,7 +18878,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: - - *61 + - *65 - *17 - *19 responses: @@ -18555,7 +18896,7 @@ paths: type: integer repository_cache_usages: type: array - items: &323 + items: &327 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -18593,7 +18934,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18613,7 +18954,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-github-hosted-runners-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -18631,7 +18972,7 @@ paths: type: integer runners: type: array - items: &107 + items: &113 title: GitHub-hosted hosted runner description: A Github-hosted hosted runner. type: object @@ -18694,7 +19035,7 @@ paths: - size_gb - display_name - source - machine_size_details: &115 + machine_size_details: &121 title: Github-owned VM details. description: Provides details of a particular machine spec. type: object @@ -18803,7 +19144,7 @@ paths: - public_ip_enabled - platform examples: - default: &135 + default: &141 value: total_count: 2 runners: @@ -18845,7 +19186,7 @@ paths: public_ips: [] last_active_on: '2023-04-26T15:23:37Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18863,7 +19204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#create-a-github-hosted-runner-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -18941,9 +19282,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: &116 + default: &122 value: id: 5 name: My hosted ubuntu runner @@ -18984,7 +19325,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -19000,7 +19341,7 @@ paths: type: integer images: type: array - items: &108 + items: &114 title: GitHub-hosted runner custom image details description: Provides details of a custom runner image type: object @@ -19059,7 +19400,7 @@ paths: - latest_version - state examples: - default: &110 + default: &116 value: total_count: 2 image_versions: @@ -19090,8 +19431,8 @@ paths: 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 - - &109 + - *65 + - &115 name: image_definition_id description: Image definition ID of custom image in: path @@ -19103,7 +19444,7 @@ paths: description: Response content: application/json: - schema: *108 + schema: *114 examples: default: value: @@ -19133,8 +19474,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization parameters: - - *61 - - *109 + - *65 + - *115 responses: '204': description: Response @@ -19157,8 +19498,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization parameters: - - *109 - - *61 + - *115 + - *65 responses: '200': description: Response @@ -19174,7 +19515,7 @@ paths: type: integer image_versions: type: array - items: &111 + items: &117 title: GitHub-hosted runner custom image version details. description: Provides details of a hosted runner custom image version @@ -19212,7 +19553,7 @@ paths: - created_on - state_details examples: - default: *110 + default: *116 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19232,9 +19573,9 @@ paths: 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 - - *109 - - &112 + - *65 + - *115 + - &118 name: version description: Version of a custom image in: path @@ -19247,7 +19588,7 @@ paths: description: Response content: application/json: - schema: *111 + schema: *117 examples: default: value: @@ -19273,9 +19614,9 @@ paths: 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 - - *109 - - *112 + - *65 + - *115 + - *118 responses: '204': description: Response @@ -19296,7 +19637,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: - - *61 + - *65 responses: '200': description: Response @@ -19312,7 +19653,7 @@ paths: type: integer images: type: array - items: &113 + items: &119 title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -19352,7 +19693,7 @@ paths: - display_name - source examples: - default: &114 + default: &120 value: id: ubuntu-20.04 platform: linux-x64 @@ -19376,7 +19717,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: - - *61 + - *65 responses: '200': description: Response @@ -19392,9 +19733,9 @@ paths: type: integer images: type: array - items: *113 + items: *119 examples: - default: *114 + default: *120 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19411,7 +19752,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: - - *61 + - *65 responses: '200': description: Response @@ -19466,7 +19807,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: - - *61 + - *65 responses: '200': description: Response @@ -19482,7 +19823,7 @@ paths: type: integer machine_specs: type: array - items: *115 + items: *121 examples: default: value: @@ -19507,7 +19848,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: - - *61 + - *65 responses: '200': description: Response @@ -19551,8 +19892,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#get-a-github-hosted-runner-for-an-organization parameters: - - *61 - - &117 + - *65 + - &123 name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. in: path @@ -19564,11 +19905,11 @@ paths: description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: *116 + default: *122 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19586,8 +19927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#update-a-github-hosted-runner-for-an-organization parameters: - - *61 - - *117 + - *65 + - *123 requestBody: required: true content: @@ -19631,9 +19972,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: *116 + default: *122 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19649,16 +19990,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/hosted-runners#delete-a-github-hosted-runner-for-an-organization parameters: - - *61 - - *117 + - *65 + - *123 responses: '202': description: Response content: application/json: - schema: *107 + schema: *113 examples: - default: *116 + default: *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -19678,13 +20019,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: - - *61 + - *65 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &118 + schema: &124 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19698,7 +20039,7 @@ paths: required: - include_claim_keys examples: - default: &119 + default: &125 value: include_claim_keys: - repo @@ -19720,20 +20061,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: - - *61 + - *65 requestBody: required: true content: application/json: - schema: *118 + schema: *124 examples: - default: *119 + default: *125 responses: '201': description: Empty response content: application/json: - schema: &145 + schema: &151 title: Empty Object description: An object without any properties. type: object @@ -19763,7 +20104,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -19772,7 +20113,7 @@ paths: schema: type: object properties: - enabled_repositories: &120 + enabled_repositories: &126 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19785,7 +20126,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: &121 + allowed_actions: &127 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -19793,12 +20134,12 @@ paths: - all - local_only - selected - selected_actions_url: &329 + selected_actions_url: &333 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: &122 + sha_pinning_required: &128 type: boolean description: Whether actions must be pinned to a full-length commit SHA. @@ -19829,7 +20170,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -19840,9 +20181,9 @@ paths: schema: type: object properties: - enabled_repositories: *120 - allowed_actions: *121 - sha_pinning_required: *122 + enabled_repositories: *126 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled_repositories examples: @@ -19870,13 +20211,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &333 + schema: &337 type: object properties: days: @@ -19913,12 +20254,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: application/json: - schema: &334 + schema: &338 type: object properties: days: @@ -19935,7 +20276,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -19955,13 +20296,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &123 + schema: &129 type: object properties: approval_policy: @@ -19975,7 +20316,7 @@ paths: required: - approval_policy examples: - default: &335 + default: &339 value: approval_policy: first_time_contributors '404': *6 @@ -19996,7 +20337,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -20006,7 +20347,7 @@ paths: required: true content: application/json: - schema: *123 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -20028,13 +20369,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: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &336 + schema: &340 type: object required: - run_workflows_from_fork_pull_requests @@ -20060,7 +20401,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: &124 + default: &130 value: run_workflows_from_fork_pull_requests: true send_write_tokens_to_workflows: false @@ -20083,12 +20424,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: - - *61 + - *65 requestBody: required: true content: application/json: - schema: &337 + schema: &341 type: object required: - run_workflows_from_fork_pull_requests @@ -20111,7 +20452,7 @@ paths: description: Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. examples: - default: *124 + default: *130 responses: '204': description: Empty response for successful settings update @@ -20141,7 +20482,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: - - *61 + - *65 - *17 - *19 responses: @@ -20159,9 +20500,9 @@ paths: type: number repositories: type: array - items: *64 + items: *68 examples: - default: &128 + default: &134 value: total_count: 1 repositories: @@ -20301,7 +20642,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: - - *61 + - *65 responses: '204': description: Response @@ -20345,8 +20686,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: - - *61 - - &125 + - *65 + - &131 name: repository_id description: The unique identifier of the repository. in: path @@ -20374,8 +20715,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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: Response @@ -20398,13 +20739,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &126 + schema: &132 type: object properties: github_owned_allowed: @@ -20426,7 +20767,7 @@ paths: items: type: string examples: - default: &127 + default: &133 value: github_owned_allowed: true verified_allowed: false @@ -20451,7 +20792,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -20459,9 +20800,9 @@ paths: required: false content: application/json: - schema: *126 + schema: *132 examples: - selected_actions: *127 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20481,7 +20822,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -20529,7 +20870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -20556,7 +20897,7 @@ paths: description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -20576,7 +20917,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: - - *61 + - *65 - *17 - *19 responses: @@ -20591,9 +20932,9 @@ paths: type: integer repositories: type: array - items: *64 + items: *68 examples: - default: *128 + default: *134 '403': *27 '404': *6 x-github: @@ -20613,7 +20954,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: - - *61 + - *65 requestBody: required: true content: @@ -20661,14 +21002,14 @@ 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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -20688,14 +21029,14 @@ 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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: No content '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 x-github: enabledForGitHubApps: true @@ -20717,23 +21058,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &338 + schema: &342 type: object properties: - default_workflow_permissions: &129 + default_workflow_permissions: &135 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &130 + can_approve_pull_request_reviews: &136 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -20741,7 +21082,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &131 + default: &137 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -20766,7 +21107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Success response @@ -20774,13 +21115,13 @@ paths: required: false content: application/json: - schema: &339 + schema: &343 type: object properties: - default_workflow_permissions: *129 - can_approve_pull_request_reviews: *130 + default_workflow_permissions: *135 + can_approve_pull_request_reviews: *136 examples: - default: *131 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20800,7 +21141,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: - - *61 + - *65 - *17 - *19 - name: visible_to_repository @@ -20825,7 +21166,7 @@ paths: type: number runner_groups: type: array - items: &132 + items: &138 type: object properties: id: @@ -20942,7 +21283,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: - - *61 + - *65 requestBody: required: true content: @@ -21015,9 +21356,9 @@ paths: description: Response content: application/json: - schema: *132 + schema: *138 examples: - default: &134 + default: &140 value: id: 2 name: octo-runner-group @@ -21052,8 +21393,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: - - *61 - - &133 + - *65 + - &139 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -21065,7 +21406,7 @@ paths: description: Response content: application/json: - schema: *132 + schema: *138 examples: default: value: @@ -21101,8 +21442,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: - - *61 - - *133 + - *65 + - *139 requestBody: required: true content: @@ -21158,9 +21499,9 @@ paths: description: Response content: application/json: - schema: *132 + schema: *138 examples: - default: *134 + default: *140 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21179,8 +21520,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: - - *61 - - *133 + - *65 + - *139 responses: '204': description: Response @@ -21203,8 +21544,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: - - *61 - - *133 + - *65 + - *139 - *17 - *19 responses: @@ -21222,11 +21563,11 @@ paths: type: number runners: type: array - items: *107 + items: *113 examples: - default: *135 + default: *141 headers: - Link: *52 + Link: *56 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21246,8 +21587,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: - - *61 - - *133 + - *65 + - *139 - *19 - *17 responses: @@ -21265,9 +21606,9 @@ paths: type: number repositories: type: array - items: *136 + items: *142 examples: - default: &642 + default: &644 value: total_count: 1 repositories: @@ -21519,8 +21860,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: - - *61 - - *133 + - *65 + - *139 requestBody: required: true content: @@ -21564,9 +21905,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: - - *61 - - *133 - - *125 + - *65 + - *139 + - *131 responses: '204': description: Response @@ -21588,9 +21929,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: - - *61 - - *133 - - *125 + - *65 + - *139 + - *131 responses: '204': description: Response @@ -21613,8 +21954,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: - - *61 - - *133 + - *65 + - *139 - *17 - *19 responses: @@ -21632,7 +21973,7 @@ paths: type: number runners: type: array - items: &138 + items: &144 title: Self hosted runners description: A self hosted runner type: object @@ -21666,7 +22007,7 @@ paths: type: boolean labels: type: array - items: &141 + items: &147 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -21696,7 +22037,7 @@ paths: - busy - labels examples: - default: &139 + default: &145 value: total_count: 2 runners: @@ -21736,7 +22077,7 @@ paths: name: no-gpu type: custom headers: - Link: *52 + Link: *56 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -21755,8 +22096,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: - - *61 - - *133 + - *65 + - *139 requestBody: required: true content: @@ -21800,9 +22141,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: - - *61 - - *133 - - &137 + - *65 + - *139 + - &143 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -21830,9 +22171,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: - - *61 - - *133 - - *137 + - *65 + - *139 + - *143 responses: '204': description: Response @@ -21862,7 +22203,7 @@ paths: in: query schema: type: string - - *61 + - *65 - *17 - *19 responses: @@ -21880,11 +22221,11 @@ paths: type: integer runners: type: array - items: *138 + items: *144 examples: - default: *139 + default: *145 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21906,7 +22247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -21914,7 +22255,7 @@ paths: application/json: schema: type: array - items: &340 + items: &344 title: Runner Application description: Runner Application type: object @@ -21939,7 +22280,7 @@ paths: - download_url - filename examples: - default: &341 + default: &345 value: - os: osx architecture: x64 @@ -21982,7 +22323,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: - - *61 + - *65 requestBody: required: true content: @@ -22025,7 +22366,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &342 + '201': &346 description: Response content: application/json: @@ -22035,7 +22376,7 @@ paths: - runner - encoded_jit_config properties: - runner: *138 + runner: *144 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -22064,7 +22405,7 @@ paths: encoded_jit_config: abc123 '404': *6 '422': *7 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22092,13 +22433,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *61 + - *65 responses: '201': description: Response content: application/json: - schema: &140 + schema: &146 title: Authentication Token description: Authentication Token type: object @@ -22122,7 +22463,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *64 + items: *68 single_file: type: - string @@ -22140,7 +22481,7 @@ paths: - token - expires_at examples: - default: &343 + default: &347 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -22171,15 +22512,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *61 + - *65 responses: '201': description: Response content: application/json: - schema: *140 + schema: *146 examples: - default: &344 + default: &348 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -22204,16 +22545,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: - - *61 - - *137 + - *65 + - *143 responses: '200': description: Response content: application/json: - schema: *138 + schema: *144 examples: - default: &345 + default: &349 value: id: 23 name: MBP @@ -22254,8 +22595,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: - - *61 - - *137 + - *65 + - *143 responses: '204': description: Response @@ -22281,10 +22622,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: - - *61 - - *137 + - *65 + - *143 responses: - '200': &142 + '200': &148 description: Response content: application/json: @@ -22298,7 +22639,7 @@ paths: type: integer labels: type: array - items: *141 + items: *147 examples: default: value: @@ -22337,8 +22678,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: - - *61 - - *137 + - *65 + - *143 requestBody: required: true content: @@ -22362,7 +22703,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -22386,8 +22727,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: - - *61 - - *137 + - *65 + - *143 requestBody: required: true content: @@ -22412,7 +22753,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -22436,10 +22777,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: - - *61 - - *137 + - *65 + - *143 responses: - '200': &346 + '200': &350 description: Response content: application/json: @@ -22453,7 +22794,7 @@ paths: type: integer labels: type: array - items: *141 + items: *147 examples: default: value: @@ -22494,9 +22835,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: - - *61 - - *137 - - &347 + - *65 + - *143 + - &351 name: name description: The name of a self-hosted runner's custom label. in: path @@ -22504,7 +22845,7 @@ paths: schema: type: string responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -22529,7 +22870,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *61 + - *65 - *17 - *19 responses: @@ -22547,7 +22888,7 @@ paths: type: integer secrets: type: array - items: &143 + items: &149 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -22599,7 +22940,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22622,13 +22963,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &359 + schema: &363 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -22663,7 +23004,7 @@ paths: - key_id - key examples: - default: &360 + default: &364 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22688,8 +23029,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *61 - - &144 + - *65 + - &150 name: secret_name description: The name of the secret. in: path @@ -22701,7 +23042,7 @@ paths: description: Response content: application/json: - schema: *143 + schema: *149 examples: default: value: @@ -22731,8 +23072,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -22789,7 +23130,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -22815,8 +23156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -22842,8 +23183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - *19 - *17 responses: @@ -22861,9 +23202,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: &148 + default: &154 value: total_count: 1 repositories: @@ -22955,8 +23296,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -23008,8 +23349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -23042,8 +23383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -23075,8 +23416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *61 - - &328 + - *65 + - &332 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)." @@ -23100,7 +23441,7 @@ paths: type: integer variables: type: array - items: &146 + items: &152 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -23169,7 +23510,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23190,7 +23531,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *61 + - *65 requestBody: required: true content: @@ -23238,7 +23579,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -23263,8 +23604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *61 - - &147 + - *65 + - &153 name: name description: The name of the variable. in: path @@ -23276,7 +23617,7 @@ paths: description: Response content: application/json: - schema: *146 + schema: *152 examples: default: value: @@ -23306,8 +23647,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 requestBody: required: true content: @@ -23369,8 +23710,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 responses: '204': description: Response @@ -23396,8 +23737,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 - *19 - *17 responses: @@ -23415,9 +23756,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 '409': description: Response when the visibility of the variable is not set to `selected` @@ -23443,8 +23784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 requestBody: required: true content: @@ -23493,8 +23834,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 - name: repository_id in: path required: true @@ -23528,8 +23869,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *61 - - *147 + - *65 + - *153 - name: repository_id in: path required: true @@ -23559,7 +23900,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record parameters: - - *61 + - *65 requestBody: required: true content: @@ -23669,7 +24010,7 @@ paths: type: integer deployment_records: type: array - items: &149 + items: &155 title: Artifact Deployment Record description: Artifact Metadata Deployment Record type: object @@ -23714,7 +24055,7 @@ paths: description: The ID of the provenance attestation associated with the deployment record. examples: - default: &150 + default: &156 value: total_count: 1 deployment_records: @@ -23745,7 +24086,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records parameters: - - *61 + - *65 - name: cluster in: path description: The cluster name. @@ -23862,9 +24203,9 @@ paths: type: integer deployment_records: type: array - items: *149 + items: *155 examples: - default: *150 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23884,7 +24225,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record parameters: - - *61 + - *65 requestBody: required: true content: @@ -24047,7 +24388,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records parameters: - - *61 + - *65 - name: subject_digest description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path @@ -24073,9 +24414,9 @@ paths: - 3 deployment_records: type: array - items: *149 + items: *155 examples: - default: *150 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24095,7 +24436,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records parameters: - - *61 + - *65 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24179,9 +24520,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *38 - - *39 - - *61 + - *43 + - *44 + - *65 requestBody: required: true content: @@ -24205,12 +24546,12 @@ paths: required: - subject_digests examples: - default: &669 + default: &671 value: subject_digests: - sha256:abc123 - sha512:def456 - withPredicateType: &670 + withPredicateType: &672 value: subject_digests: - sha256:abc123 @@ -24269,7 +24610,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: &671 + default: &673 value: attestations_subject_digests: - sha256:abc: @@ -24378,7 +24719,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk parameters: - - *61 + - *65 requestBody: required: true content: @@ -24443,7 +24784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest parameters: - - *61 + - *65 - name: subject_digest description: Subject Digest in: path @@ -24476,9 +24817,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories parameters: - *17 - - *38 - - *39 - - *61 + - *43 + - *44 + - *65 - name: predicate_type description: |- Optional filter for fetching attestations with a given predicate type. @@ -24526,7 +24867,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id parameters: - - *61 + - *65 - name: attestation_id description: Attestation ID in: path @@ -24562,9 +24903,9 @@ paths: url: https://docs.github.com/rest/orgs/attestations#list-attestations parameters: - *17 - - *38 - - *39 - - *61 + - *43 + - *44 + - *65 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24618,7 +24959,7 @@ paths: initiator: type: string examples: - default: &373 + default: &377 value: attestations: - bundle: @@ -24725,7 +25066,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -24737,7 +25078,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24756,8 +25097,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: If the user is blocked @@ -24782,8 +25123,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -24803,8 +25144,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -24829,15 +25170,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization parameters: - - *61 + - *65 - *19 - *17 - - *46 + - *50 - name: state description: If specified, only campaigns with this state will be returned. in: query required: false - schema: &151 + schema: &157 title: Campaign state description: Indicates whether a campaign is open or closed type: string @@ -24863,7 +25204,7 @@ paths: application/json: schema: type: array - items: &152 + items: &158 title: Campaign summary description: The campaign metadata and alert stats. type: object @@ -24894,7 +25235,7 @@ paths: team_managers: description: The campaign team managers type: array - items: &172 + items: &178 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -24971,7 +25312,7 @@ paths: parent: anyOf: - type: 'null' - - &223 + - &229 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -25107,7 +25448,7 @@ paths: - string - 'null' format: date-time - state: *151 + state: *157 contact_link: description: The contact link of the campaign. type: @@ -25203,9 +25544,9 @@ paths: closed_at: state: open headers: - Link: *52 + Link: *56 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25229,7 +25570,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -25330,9 +25671,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: - default: &153 + default: &159 value: number: 3 created_at: '2024-02-14T12:29:18Z' @@ -25381,7 +25722,7 @@ paths: schema: *3 '429': description: Too Many Requests - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25403,7 +25744,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization parameters: - - *61 + - *65 - name: campaign_number description: The campaign number. in: path @@ -25415,16 +25756,16 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: - default: *153 + default: *159 '404': *6 '422': description: Unprocessable Entity content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25445,7 +25786,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign parameters: - - *61 + - *65 - name: campaign_number description: The campaign number. in: path @@ -25495,7 +25836,7 @@ paths: - string - 'null' format: uri - state: *151 + state: *157 examples: default: value: @@ -25505,9 +25846,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *158 examples: - default: *153 + default: *159 '400': description: Bad Request content: @@ -25519,7 +25860,7 @@ paths: content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25540,7 +25881,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization parameters: - - *61 + - *65 - name: campaign_number description: The campaign number. in: path @@ -25551,7 +25892,7 @@ paths: '204': description: Deletion successful '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25573,18 +25914,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *61 - - &398 + - *65 + - &402 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: &161 + schema: &167 type: string description: The name of the tool used to generate the code scanning analysis. - - &399 + - &403 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 @@ -25592,23 +25933,23 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &162 + schema: &168 type: - string - 'null' description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *38 - - *39 + - *43 + - *44 - *19 - *17 - - *46 + - *50 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &401 + schema: &405 type: string description: State of a code scanning alert. enum: @@ -25631,7 +25972,7 @@ paths: be returned. in: query required: false - schema: &402 + schema: &406 type: string description: Severity of a code scanning alert. enum: @@ -25652,18 +25993,18 @@ paths: items: type: object properties: - number: *154 - created_at: *155 - updated_at: *156 - url: *157 - html_url: *158 - instances_url: &403 + number: *160 + created_at: *161 + updated_at: *162 + url: *163 + html_url: *164 + instances_url: &407 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &163 + state: &169 type: - string - 'null' @@ -25673,13 +26014,13 @@ paths: - dismissed - fixed - - fixed_at: *159 + fixed_at: *165 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *160 - dismissed_reason: &404 + dismissed_at: *166 + dismissed_reason: &408 type: - string - 'null' @@ -25690,14 +26031,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &405 + dismissed_comment: &409 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &406 + rule: &410 type: object properties: id: @@ -25758,26 +26099,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &407 + tool: &411 type: object properties: - name: *161 + name: *167 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *162 - most_recent_instance: &408 + guid: *168 + most_recent_instance: &412 type: object properties: - ref: &400 + ref: &404 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &418 + analysis_key: &422 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -25788,13 +26129,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &419 + category: &423 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: *163 + state: *169 commit_sha: type: string message: @@ -25835,7 +26176,7 @@ paths: - test - library - - repository: *51 + repository: *55 dismissal_approved_by: anyOf: - type: 'null' @@ -26087,9 +26428,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: *52 + Link: *56 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26111,7 +26452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *61 + - *65 - name: target_type in: query description: The target type of the code security configuration @@ -26130,8 +26471,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -26139,7 +26480,7 @@ paths: application/json: schema: type: array - items: *41 + items: *45 examples: default: value: @@ -26222,7 +26563,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *61 + - *65 requestBody: required: true content: @@ -26300,7 +26641,7 @@ paths: - disabled - not_set default: disabled - code_scanning_options: *164 + code_scanning_options: *170 code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -26309,7 +26650,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: *44 + code_scanning_default_setup_options: *48 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -26441,9 +26782,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *41 + schema: *45 examples: - default: *165 + default: *171 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26465,15 +26806,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *166 + schema: *172 examples: - default: *167 + default: *173 '304': *35 '403': *27 '404': *6 @@ -26499,7 +26840,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *61 + - *65 requestBody: required: true content: @@ -26525,11 +26866,11 @@ paths: - 32 - 91 responses: - '204': *168 + '204': *174 '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26551,16 +26892,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 responses: '200': description: Response content: application/json: - schema: *41 + schema: *45 examples: - default: *165 + default: *171 '304': *35 '403': *27 '404': *6 @@ -26584,8 +26925,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 requestBody: required: true content: @@ -26664,7 +27005,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *44 + code_scanning_default_setup_options: *48 code_scanning_delegated_alert_dismissal: type: string description: The enablement status of code scanning delegated alert @@ -26782,7 +27123,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *41 + schema: *45 examples: default: value: @@ -26841,14 +27182,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 responses: - '204': *168 + '204': *174 '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26872,8 +27213,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *61 - - *43 + - *65 + - *47 requestBody: required: true content: @@ -26936,8 +27277,8 @@ 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: - - *61 - - *43 + - *65 + - *47 requestBody: required: true content: @@ -26977,12 +27318,12 @@ paths: - none - private_and_internal - public - configuration: *41 + configuration: *45 examples: default: value: default_for_new_repos: all - configuration: *165 + configuration: *171 '403': *27 '404': *6 x-github: @@ -27006,8 +27347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *61 - - *43 + - *65 + - *47 - 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)." @@ -27016,8 +27357,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -27035,13 +27376,13 @@ paths: application/json: schema: type: array - items: *169 + items: *175 examples: default: summary: Example of code security configuration repositories value: - status: attached - repository: *170 + repository: *176 '403': *27 '404': *6 x-github: @@ -27065,7 +27406,7 @@ paths: parameters: - *17 - *19 - - *61 + - *65 responses: '200': description: Response @@ -27081,7 +27422,7 @@ paths: type: integer codespaces: type: array - items: &213 + items: &219 type: object title: Codespace description: A codespace. @@ -27112,11 +27453,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *136 + repository: *142 machine: anyOf: - type: 'null' - - &431 + - &435 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -27403,7 +27744,7 @@ paths: - pulls_url - recent_folders examples: - default: &214 + default: &220 value: total_count: 3 codespaces: @@ -27813,7 +28154,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -27835,7 +28176,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *61 + - *65 deprecated: true requestBody: required: true @@ -27879,7 +28220,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27902,7 +28243,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *61 + - *65 deprecated: true requestBody: required: true @@ -27934,7 +28275,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27957,7 +28298,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *61 + - *65 requestBody: required: true content: @@ -27988,7 +28329,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28009,7 +28350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *61 + - *65 - *17 - *19 responses: @@ -28027,7 +28368,7 @@ paths: type: integer secrets: type: array - items: &171 + items: &177 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -28068,7 +28409,7 @@ paths: - updated_at - visibility examples: - default: &432 + default: &436 value: total_count: 2 secrets: @@ -28081,7 +28422,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28100,13 +28441,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &433 + schema: &437 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -28141,7 +28482,7 @@ paths: - key_id - key examples: - default: &434 + default: &438 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -28164,23 +28505,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '200': description: Response content: application/json: - schema: *171 + schema: *177 examples: - default: &436 + default: &440 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -28200,8 +28541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -28256,7 +28597,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -28282,8 +28623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -28308,8 +28649,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - *19 - *17 responses: @@ -28327,9 +28668,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 '404': *6 x-github: githubCloudOnly: false @@ -28351,8 +28692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -28402,8 +28743,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -28436,8 +28777,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -28476,7 +28817,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: - - *61 + - *65 responses: '200': description: OK @@ -28585,7 +28926,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28617,7 +28958,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: - - *61 + - *65 - *19 - name: per_page description: The number of results per page (max 100). For more information, @@ -28640,7 +28981,7 @@ paths: currently being billed. seats: type: array - items: &216 + items: &222 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -28653,13 +28994,13 @@ paths: organization: anyOf: - type: 'null' - - *59 + - *63 assigning_team: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - *172 - - *53 + - *178 + - *57 type: - 'null' - object @@ -28789,8 +29130,8 @@ paths: type: User site_admin: false headers: - Link: *52 - '500': *96 + Link: *56 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28823,7 +29164,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: - - *61 + - *65 requestBody: content: application/json: @@ -28865,7 +29206,7 @@ paths: default: value: seats_created: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28901,7 +29242,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: - - *61 + - *65 requestBody: content: application/json: @@ -28943,7 +29284,7 @@ paths: default: value: seats_cancelled: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -28981,7 +29322,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: - - *61 + - *65 requestBody: content: application/json: @@ -29022,7 +29363,7 @@ paths: default: value: seats_created: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -29058,7 +29399,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: - - *61 + - *65 requestBody: content: application/json: @@ -29100,7 +29441,7 @@ paths: default: value: seats_cancelled: 5 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -29139,7 +29480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *61 + - *65 - 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`). @@ -29171,7 +29512,7 @@ paths: application/json: schema: type: array - items: &293 + items: &300 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -29486,7 +29827,7 @@ paths: - date additionalProperties: true examples: - default: &294 + default: &301 value: - date: '2024-06-24' total_active_users: 24 @@ -29585,10 +29926,10 @@ paths: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - '500': *96 + '500': *102 '403': *27 '404': *6 - '422': &295 + '422': &302 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: @@ -29615,12 +29956,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *61 - - *173 - - *174 - - *175 - - *176 - - *177 + - *65 + - *179 + - *180 + - *181 + - *182 + - *183 - name: artifact_registry_url in: query description: A comma-separated list of artifact registry URLs. If specified, @@ -29658,11 +29999,11 @@ paths: Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` schema: type: string - - *178 - - *179 - - *46 - - *38 - - *39 + - *184 + - *185 + - *50 + - *43 + - *44 - *17 responses: '200': @@ -29671,9 +30012,9 @@ paths: application/json: schema: type: array - items: *180 + items: *186 examples: - default: *181 + default: *187 '304': *35 '400': *14 '403': *27 @@ -29699,7 +30040,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *61 + - *65 - *17 - *19 responses: @@ -29717,7 +30058,7 @@ paths: type: integer secrets: type: array - items: &182 + items: &188 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29769,7 +30110,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29790,13 +30131,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: &459 + schema: &463 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -29815,7 +30156,7 @@ paths: - key_id - key examples: - default: &460 + default: &464 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29838,14 +30179,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '200': description: Response content: application/json: - schema: *182 + schema: *188 examples: default: value: @@ -29873,8 +30214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -29933,7 +30274,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -29957,8 +30298,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -29982,8 +30323,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - *19 - *17 responses: @@ -30001,9 +30342,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30024,8 +30365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -30075,8 +30416,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -30107,8 +30448,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *61 - - *144 + - *65 + - *150 - name: repository_id in: path required: true @@ -30138,7 +30479,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: - - *61 + - *65 responses: '200': description: Response @@ -30146,7 +30487,7 @@ paths: application/json: schema: type: array - items: &225 + items: &231 title: Package description: A software package type: object @@ -30199,7 +30540,7 @@ paths: repository: anyOf: - type: 'null' - - *136 + - *142 created_at: type: string format: date-time @@ -30217,7 +30558,7 @@ paths: - created_at - updated_at examples: - default: &226 + default: &232 value: - id: 197 name: hello_docker @@ -30295,7 +30636,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *61 + - *65 - *17 - *19 responses: @@ -30305,7 +30646,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: 200-response: value: @@ -30377,7 +30718,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *61 + - *65 - *17 - *19 responses: @@ -30387,7 +30728,7 @@ paths: application/json: schema: type: array - items: &205 + items: &211 title: Organization Invitation description: Organization Invitation type: object @@ -30441,7 +30782,7 @@ paths: - invitation_teams_url - node_id examples: - default: &206 + default: &212 value: - id: 1 login: monalisa @@ -30474,7 +30815,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -30498,7 +30839,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *61 + - *65 - *17 - *19 responses: @@ -30508,7 +30849,7 @@ paths: application/json: schema: type: array - items: &183 + items: &189 title: Org Hook description: Org Hook type: object @@ -30608,7 +30949,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -30631,7 +30972,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *61 + - *65 requestBody: required: true content: @@ -30693,9 +31034,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *189 examples: - default: &184 + default: &190 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30742,8 +31083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *61 - - &185 + - *65 + - &191 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. @@ -30756,9 +31097,9 @@ paths: description: Response content: application/json: - schema: *183 + schema: *189 examples: - default: *184 + default: *190 '404': *6 x-github: githubCloudOnly: false @@ -30785,8 +31126,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 requestBody: required: false content: @@ -30832,7 +31173,7 @@ paths: description: Response content: application/json: - schema: *183 + schema: *189 examples: default: value: @@ -30873,8 +31214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 responses: '204': description: Response @@ -30901,8 +31242,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *61 - - *185 + - *65 + - *191 responses: '200': description: Response @@ -30932,8 +31273,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *61 - - *185 + - *65 + - *191 requestBody: required: false content: @@ -30983,10 +31324,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 - *17 - - *186 + - *192 responses: '200': description: Response @@ -30994,9 +31335,9 @@ paths: application/json: schema: type: array - items: *187 + items: *193 examples: - default: *188 + default: *194 '400': *14 '422': *15 x-github: @@ -31021,17 +31362,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 - *16 responses: '200': description: Response content: application/json: - schema: *189 + schema: *195 examples: - default: *190 + default: *196 '400': *14 '422': *15 x-github: @@ -31056,8 +31397,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 - *16 responses: '202': *37 @@ -31086,8 +31427,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *61 - - *185 + - *65 + - *191 responses: '204': description: Response @@ -31109,8 +31450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *61 - - &195 + - *65 + - &201 name: actor_type in: path description: The type of the actor @@ -31123,14 +31464,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &196 + - &202 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &191 + - &197 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`.' @@ -31138,7 +31479,7 @@ paths: required: true schema: type: string - - &192 + - &198 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) @@ -31149,7 +31490,7 @@ paths: type: string - *19 - *17 - - *46 + - *50 - name: sort description: The property to sort the results by. in: query @@ -31232,13 +31573,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *61 - - *191 - - *192 + - *65 + - *197 + - *198 - *19 - *17 - - *46 - - &201 + - *50 + - &207 name: sort description: The property to sort the results by. in: query @@ -31317,15 +31658,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *61 - - *191 - - *192 + - *65 + - *197 + - *198 responses: '200': description: Response content: application/json: - schema: &193 + schema: &199 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -31341,7 +31682,7 @@ paths: type: integer format: int64 examples: - default: &194 + default: &200 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -31361,24 +31702,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *61 - - &197 + - *65 + - &203 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *191 - - *192 + - *197 + - *198 responses: '200': description: Response content: application/json: - schema: *193 + schema: *199 examples: - default: *194 + default: *200 x-github: enabledForGitHubApps: true category: orgs @@ -31396,19 +31737,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *61 - - *191 - - *192 - - *195 - - *196 + - *65 + - *197 + - *198 + - *201 + - *202 responses: '200': description: Response content: application/json: - schema: *193 + schema: *199 examples: - default: *194 + default: *200 x-github: enabledForGitHubApps: true category: orgs @@ -31425,10 +31766,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *61 - - *191 - - *192 - - &198 + - *65 + - *197 + - *198 + - &204 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -31441,7 +31782,7 @@ paths: description: Response content: application/json: - schema: &199 + schema: &205 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -31457,7 +31798,7 @@ paths: type: integer format: int64 examples: - default: &200 + default: &206 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -31493,19 +31834,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *61 + - *65 + - *203 - *197 - - *191 - - *192 - *198 + - *204 responses: '200': description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: *200 + default: *206 x-github: enabledForGitHubApps: true category: orgs @@ -31522,20 +31863,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *61 - - *195 - - *196 - - *191 - - *192 + - *65 + - *201 + - *202 + - *197 - *198 + - *204 responses: '200': description: Response content: application/json: - schema: *199 + schema: *205 examples: - default: *200 + default: *206 x-github: enabledForGitHubApps: true category: orgs @@ -31552,14 +31893,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *61 + - *65 + - *203 - *197 - - *191 - - *192 + - *198 - *19 - *17 - - *46 - - *201 + - *50 + - *207 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -31635,7 +31976,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *61 + - *65 responses: '200': description: Response @@ -31643,7 +31984,7 @@ paths: application/json: schema: *20 examples: - default: &498 + default: &502 value: id: 1 account: @@ -31712,7 +32053,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -31782,7 +32123,7 @@ paths: suspended_at: suspended_by: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31801,7 +32142,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -31809,12 +32150,12 @@ paths: application/json: schema: anyOf: - - &203 + - &209 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &202 + limit: &208 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -31842,7 +32183,7 @@ paths: properties: {} additionalProperties: false examples: - default: &204 + default: &210 value: limit: collaborators_only origin: organization @@ -31866,18 +32207,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: application/json: - schema: &499 + schema: &503 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *202 + limit: *208 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31902,9 +32243,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *209 examples: - default: *204 + default: *210 '422': *15 x-github: githubCloudOnly: false @@ -31922,7 +32263,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -31946,7 +32287,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *61 + - *65 - *17 - *19 - name: role @@ -31980,11 +32321,11 @@ paths: application/json: schema: type: array - items: *205 + items: *211 examples: - default: *206 + default: *212 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -32005,7 +32346,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *61 + - *65 requestBody: required: false content: @@ -32059,7 +32400,7 @@ paths: description: Response content: application/json: - schema: *205 + schema: *211 examples: default: value: @@ -32113,8 +32454,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *61 - - &207 + - *65 + - &213 name: invitation_id description: The unique identifier of the invitation. in: path @@ -32144,8 +32485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *61 - - *207 + - *65 + - *213 - *17 - *19 responses: @@ -32155,9 +32496,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: &224 + default: &230 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -32173,7 +32514,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -32192,7 +32533,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -32200,7 +32541,7 @@ paths: application/json: schema: type: array - items: *208 + items: *214 examples: default: value: @@ -32238,7 +32579,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -32288,9 +32629,9 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: - default: &209 + default: &215 value: id: 410 node_id: IT_kwDNAd3NAZo @@ -32322,8 +32663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization parameters: - - *61 - - &210 + - *65 + - &216 name: issue_type_id description: The unique identifier of the issue type. in: path @@ -32379,9 +32720,9 @@ paths: description: Response content: application/json: - schema: *208 + schema: *214 examples: - default: *209 + default: *215 '404': *6 '422': *7 x-github: @@ -32405,8 +32746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization parameters: - - *61 - - *210 + - *65 + - *216 responses: '204': description: Response @@ -32439,7 +32780,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *61 + - *65 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -32469,7 +32810,7 @@ paths: - closed - all default: open - - *211 + - *217 - name: type description: Can be the name of an issue type. in: query @@ -32487,8 +32828,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - *17 - *19 responses: @@ -32498,11 +32839,11 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *212 + default: *218 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -32522,7 +32863,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *61 + - *65 - 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) @@ -32560,9 +32901,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -32580,8 +32921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response if requester is an organization member and user is @@ -32615,8 +32956,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -32642,8 +32983,8 @@ paths: parameters: - *17 - *19 + - *65 - *61 - - *57 responses: '200': description: Response @@ -32659,11 +33000,11 @@ paths: type: integer codespaces: type: array - items: *213 + items: *219 examples: - default: *214 + default: *220 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32686,9 +33027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: + - *65 - *61 - - *57 - - &215 + - &221 name: codespace_name in: path required: true @@ -32698,7 +33039,7 @@ paths: responses: '202': *37 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32721,17 +33062,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: + - *65 - *61 - - *57 - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: &430 + default: &434 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32873,7 +33214,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32904,14 +33245,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: + - *65 - *61 - - *57 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *216 + schema: *222 examples: default: value: @@ -32955,7 +33296,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -32980,14 +33321,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '200': description: Response content: application/json: - schema: &217 + schema: &223 title: Org Membership description: Org Membership type: object @@ -33036,7 +33377,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *59 + organization: *63 user: anyOf: - type: 'null' @@ -33056,7 +33397,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &218 + response-if-user-has-an-active-admin-membership-with-organization: &224 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -33124,8 +33465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 requestBody: required: false content: @@ -33153,9 +33494,9 @@ paths: description: Response content: application/json: - schema: *217 + schema: *223 examples: - response-if-user-already-had-membership-with-organization: *218 + response-if-user-already-had-membership-with-organization: *224 '422': *15 '403': *27 x-github: @@ -33179,8 +33520,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -33205,7 +33546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *61 + - *65 - *17 - *19 - name: exclude @@ -33227,7 +33568,7 @@ paths: application/json: schema: type: array - items: &219 + items: &225 title: Migration description: A migration. type: object @@ -33269,7 +33610,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *64 + items: *68 url: type: string format: uri @@ -33468,7 +33809,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -33484,7 +33825,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *61 + - *65 requestBody: required: true content: @@ -33565,7 +33906,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -33743,8 +34084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *61 - - &220 + - *65 + - &226 name: migration_id description: The unique identifier of the migration. in: path @@ -33772,7 +34113,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -33941,8 +34282,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *61 - - *220 + - *65 + - *226 responses: '302': description: Response @@ -33963,8 +34304,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *61 - - *220 + - *65 + - *226 responses: '204': description: Response @@ -33987,9 +34328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *61 - - *220 - - &654 + - *65 + - *226 + - &656 name: repo_name description: repo_name parameter in: path @@ -34016,8 +34357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *61 - - *220 + - *65 + - *226 - *17 - *19 responses: @@ -34027,9 +34368,9 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: &231 + default: &237 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -34140,7 +34481,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -34166,7 +34507,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response - list of organization roles @@ -34182,7 +34523,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &222 + items: &228 title: Organization Role description: Organization roles type: object @@ -34331,8 +34672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -34357,9 +34698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *61 - - *62 - - &221 + - *65 + - *66 + - &227 name: role_id description: The unique identifier of the role. in: path @@ -34394,9 +34735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *61 - - *62 - - *221 + - *65 + - *66 + - *227 responses: '204': description: Response @@ -34421,8 +34762,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -34447,9 +34788,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: + - *65 - *61 - - *57 - - *221 + - *227 responses: '204': description: Response @@ -34479,9 +34820,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: + - *65 - *61 - - *57 - - *221 + - *227 responses: '204': description: Response @@ -34509,14 +34850,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *61 - - *221 + - *65 + - *227 responses: '200': description: Response content: application/json: - schema: *222 + schema: *228 examples: default: value: @@ -34566,8 +34907,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: - - *61 - - *221 + - *65 + - *227 - *17 - *19 responses: @@ -34646,7 +34987,7 @@ paths: parent: anyOf: - type: 'null' - - *223 + - *229 type: description: The ownership type of the team type: string @@ -34679,9 +35020,9 @@ paths: - type - parent examples: - default: *224 + default: *230 headers: - Link: *52 + Link: *56 '404': description: Response if the organization or role does not exist. '422': @@ -34708,8 +35049,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: - - *61 - - *221 + - *65 + - *227 - *17 - *19 responses: @@ -34738,7 +35079,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *223 + items: *229 name: type: - string @@ -34855,9 +35196,9 @@ paths: - type - url examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '404': description: Response if the organization or role does not exist. '422': @@ -34879,7 +35220,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *61 + - *65 - 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) @@ -34906,9 +35247,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34931,8 +35272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: + - *65 - *61 - - *57 requestBody: required: false content: @@ -34989,8 +35330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -35047,8 +35388,8 @@ paths: - docker - nuget - container - - *61 - - &655 + - *65 + - &657 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35084,12 +35425,12 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *226 + default: *232 '403': *27 '401': *23 - '400': &657 + '400': &659 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35111,7 +35452,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &227 + - &233 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 @@ -35129,20 +35470,20 @@ paths: - docker - nuget - container - - &228 + - &234 name: package_name description: The name of the package. in: path required: true schema: type: string - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *225 + schema: *231 examples: default: value: @@ -35194,9 +35535,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *227 - - *228 - - *61 + - *233 + - *234 + - *65 responses: '204': description: Response @@ -35228,9 +35569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *227 - - *228 - - *61 + - *233 + - *234 + - *65 - name: token description: package token schema: @@ -35262,9 +35603,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: - - *227 - - *228 - - *61 + - *233 + - *234 + - *65 - *19 - *17 - name: state @@ -35284,7 +35625,7 @@ paths: application/json: schema: type: array - items: &229 + items: &235 title: Package Version description: A version of a software package type: object @@ -35419,10 +35760,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *227 - - *228 - - *61 - - &230 + - *233 + - *234 + - *65 + - &236 name: package_version_id description: Unique identifier of the package version. in: path @@ -35434,7 +35775,7 @@ paths: description: Response content: application/json: - schema: *229 + schema: *235 examples: default: value: @@ -35470,10 +35811,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *227 - - *228 - - *61 - - *230 + - *233 + - *234 + - *65 + - *236 responses: '204': description: Response @@ -35505,10 +35846,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *227 - - *228 - - *61 - - *230 + - *233 + - *234 + - *65 + - *236 responses: '204': description: Response @@ -35535,10 +35876,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: - - *61 + - *65 - *17 - *19 - - &232 + - &238 name: sort description: The property by which to sort the results. in: query @@ -35548,8 +35889,8 @@ paths: enum: - created_at default: created_at - - *46 - - &233 + - *50 + - &239 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -35561,7 +35902,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &234 + - &240 name: repository description: The name of the repository to use to filter the results. in: query @@ -35570,7 +35911,7 @@ paths: type: string examples: - Hello-World - - &235 + - &241 name: permission description: The permission to use to filter the results. in: query @@ -35579,7 +35920,7 @@ paths: type: string examples: - issues_read - - &236 + - &242 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) @@ -35589,7 +35930,7 @@ paths: schema: type: string format: date-time - - &237 + - &243 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) @@ -35599,7 +35940,7 @@ paths: schema: type: string format: date-time - - &238 + - &244 name: token_id description: The ID of the token in: query @@ -35612,7 +35953,7 @@ paths: examples: - token_id[]=1,token_id[]=2 responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 @@ -35747,7 +36088,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35767,7 +36108,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: - - *61 + - *65 requestBody: required: true content: @@ -35809,7 +36150,7 @@ paths: action: deny reason: Access is too broad. responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 @@ -35834,7 +36175,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: - - *61 + - *65 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35871,11 +36212,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35896,7 +36237,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: - - *61 + - *65 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35907,7 +36248,7 @@ paths: - *17 - *19 responses: - '500': *96 + '500': *102 '404': *6 '403': *27 '200': @@ -35916,11 +36257,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35941,19 +36282,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: - - *61 + - *65 - *17 - *19 - - *232 - - *46 - - *233 - - *234 - - *235 - - *236 - - *237 - *238 + - *50 + - *239 + - *240 + - *241 + - *242 + - *243 + - *244 responses: - '500': *96 + '500': *102 '422': *15 '404': *6 '403': *27 @@ -36082,7 +36423,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36102,7 +36443,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: - - *61 + - *65 requestBody: required: true content: @@ -36137,7 +36478,7 @@ paths: - 1296269 - 1296280 responses: - '500': *96 + '500': *102 '404': *6 '202': *37 '403': *27 @@ -36162,7 +36503,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: - - *61 + - *65 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -36190,9 +36531,9 @@ paths: value: action: revoke responses: - '500': *96 + '500': *102 '404': *6 - '204': *168 + '204': *174 '403': *27 '422': *15 x-github: @@ -36214,7 +36555,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: - - *61 + - *65 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -36224,7 +36565,7 @@ paths: - *17 - *19 responses: - '500': *96 + '500': *102 '404': *6 '403': *27 '200': @@ -36233,11 +36574,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36259,7 +36600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -36277,7 +36618,7 @@ paths: type: integer configurations: type: array - items: &239 + items: &245 title: Organization private registry description: Private registry configuration for an organization type: object @@ -36360,7 +36701,7 @@ paths: updated_at: '2020-01-10T14:59:22Z' visibility: selected headers: - Link: *52 + Link: *56 '400': *14 '404': *6 x-github: @@ -36382,7 +36723,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -36573,7 +36914,7 @@ paths: - created_at - updated_at examples: - org-private-registry-with-selected-visibility: &240 + org-private-registry-with-selected-visibility: &246 value: name: MAVEN_REPOSITORY_SECRET registry_type: maven_repository @@ -36614,7 +36955,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: - - *61 + - *65 responses: '200': description: Response @@ -36642,7 +36983,7 @@ paths: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -36664,16 +37005,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization parameters: - - *61 - - *144 + - *65 + - *150 responses: '200': description: The specified private registry configuration for the organization content: application/json: - schema: *239 + schema: *245 examples: - default: *240 + default: *246 '404': *6 x-github: githubCloudOnly: false @@ -36694,8 +37035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization parameters: - - *61 - - *144 + - *65 + - *150 requestBody: required: true content: @@ -36800,8 +37141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization parameters: - - *61 - - *144 + - *65 + - *150 responses: '204': description: Response @@ -36824,15 +37165,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - - *61 + - *65 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *38 - - *39 + - *43 + - *44 - *17 responses: '200': @@ -36841,7 +37182,7 @@ paths: application/json: schema: type: array - items: &241 + items: &247 title: Projects v2 Project description: A projects v2 project type: object @@ -36915,7 +37256,7 @@ paths: latest_status_update: anyOf: - type: 'null' - - &728 + - &739 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -37000,7 +37341,7 @@ paths: - deleted_at - deleted_by examples: - default: &242 + default: &248 value: id: 2 node_id: MDc6UHJvamVjdDEwMDI2MDM= @@ -37083,7 +37424,7 @@ paths: updated_at: '2025-07-11T16:19:28Z' is_template: true headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -37103,24 +37444,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-organization parameters: - - &243 + - &249 name: project_number description: The project's number. in: path required: true schema: type: integer - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: - default: *242 + default: *248 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -37140,8 +37481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - - *61 - - *243 + - *65 + - *249 requestBody: required: true description: Details of the draft item to create in the project. @@ -37175,7 +37516,7 @@ paths: description: Response content: application/json: - schema: &248 + schema: &254 title: Projects v2 Item description: An item belonging to a project type: object @@ -37188,8 +37529,8 @@ paths: description: The node ID of the project item. content: oneOf: - - *78 - - &443 + - *82 + - &447 title: Pull Request Simple description: Pull Request Simple type: object @@ -37309,7 +37650,7 @@ paths: milestone: anyOf: - type: 'null' - - *244 + - *250 active_lock_reason: type: - string @@ -37364,7 +37705,7 @@ paths: type: - array - 'null' - items: *172 + items: *178 head: type: object properties: @@ -37372,7 +37713,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: @@ -37392,7 +37733,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: @@ -37408,7 +37749,7 @@ paths: _links: type: object properties: - comments: &245 + comments: &251 title: Link description: Hypermedia Link type: object @@ -37417,13 +37758,13 @@ paths: type: string required: - href - commits: *245 - statuses: *245 - html: *245 - issue: *245 - review_comments: *245 - review_comment: *245 - self: *245 + commits: *251 + statuses: *251 + html: *251 + issue: *251 + review_comments: *251 + review_comment: *251 + self: *251 required: - comments - commits @@ -37433,8 +37774,8 @@ paths: - review_comments - review_comment - self - author_association: *65 - auto_merge: &544 + author_association: *69 + auto_merge: &548 title: Auto merge description: The status of auto merging a pull request. type: @@ -37536,7 +37877,7 @@ paths: - created_at - updated_at description: The content represented by the item. - content_type: &247 + content_type: &253 title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string @@ -37580,7 +37921,7 @@ paths: - updated_at - archived_at examples: - draft_issue: &249 + draft_issue: &255 value: id: 17 node_id: PVTI_lADOANN5s84ACbL0zgBueEI @@ -37654,11 +37995,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization parameters: - - *243 - - *61 + - *249 + - *65 - *17 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -37666,7 +38007,7 @@ paths: application/json: schema: type: array - items: &246 + items: &252 title: Projects v2 Field description: A field inside a projects v2 project type: object @@ -37816,7 +38157,7 @@ paths: - updated_at - project_url examples: - default: &674 + default: &676 value: - id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37850,60 +38191,351 @@ paths: raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' - - id: 67891 - node_id: PVTF_lADOABCD9876543210 - name: Status - data_type: single_select - project_url: https://api.github.com/projects/67890 - options: - - id: option_4 - name: - html: Todo - raw: Todo - color: GRAY - description: - html: Items to be worked on - raw: Items to be worked on - - id: option_5 - name: - html: In Progress - raw: In Progress - color: BLUE - description: - html: Items currently being worked on - raw: Items currently being worked on - - id: option_6 - name: - html: Done - raw: Done - color: GREEN - description: - html: Completed items - raw: Completed items - created_at: '2022-04-29T10:30:00Z' - updated_at: '2022-04-29T10:30:00Z' - - id: 24680 - node_id: PVTF_lADOABCD2468024680 - name: Team notes - data_type: text - project_url: https://api.github.com/projects/67890 - created_at: '2022-05-15T08:00:00Z' - updated_at: '2022-05-15T08:00:00Z' - - id: 13579 - node_id: PVTF_lADOABCD1357913579 - name: Story points - data_type: number - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-01T14:30:00Z' - updated_at: '2022-06-01T14:30:00Z' - - id: 98765 - node_id: PVTF_lADOABCD9876598765 - name: Due date - data_type: date - project_url: https://api.github.com/projects/67890 - created_at: '2022-06-10T09:15:00Z' - updated_at: '2022-06-10T09:15:00Z' - - id: 11223 + - id: 67891 + node_id: PVTF_lADOABCD9876543210 + name: Status + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_4 + name: + html: Todo + raw: Todo + color: GRAY + description: + html: Items to be worked on + raw: Items to be worked on + - id: option_5 + name: + html: In Progress + raw: In Progress + color: BLUE + description: + html: Items currently being worked on + raw: Items currently being worked on + - id: option_6 + name: + html: Done + raw: Done + color: GREEN + description: + html: Completed items + raw: Completed items + created_at: '2022-04-29T10:30:00Z' + updated_at: '2022-04-29T10:30:00Z' + - id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + - id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + - id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + - id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + headers: + Link: *56 + '304': *35 + '403': *27 + '401': *23 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - *249 + - *65 + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + required: + - issue_field_id + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: &677 + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: &678 + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. + Individual iterations can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: &679 + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + iteration_field: &680 + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: *252 + examples: + text_field: &681 + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + number_field: &682 + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + date_field: &683 + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + single_select_field: &684 + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + iteration_field: &685 + value: + id: 11223 node_id: PVTF_lADOABCD1122311223 name: Sprint data_type: iteration @@ -37926,11 +38558,10 @@ paths: duration: 14 created_at: '2022-06-20T16:45:00Z' updated_at: '2022-06-20T16:45:00Z' - headers: - Link: *52 '304': *35 '403': *27 '401': *23 + '422': *15 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37947,23 +38578,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization parameters: - - *243 - - &675 + - *249 + - &686 name: field_id description: The unique identifier of the field. in: path required: true schema: type: integer - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *246 + schema: *252 examples: - default: &676 + default: &687 value: id: 12345 node_id: PVTF_lADOABCD1234567890 @@ -37972,21 +38603,33 @@ paths: project_url: https://api.github.com/projects/67890 options: - id: option_1 - name: Low + name: + html: Low + raw: Low color: GREEN - description: Low priority items + description: + html: Low priority items + raw: Low priority items - id: option_2 - name: Medium + name: + html: Medium + raw: Medium color: YELLOW - description: Medium priority items + description: + html: Medium priority items + raw: Medium priority items - id: option_3 - name: High + name: + html: High + raw: High color: RED - description: High priority items + description: + html: High priority items + raw: High priority items created_at: '2022-04-28T12:00:00Z' updated_at: '2022-04-28T12:00:00Z' headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -38007,8 +38650,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project parameters: - - *243 - - *61 + - *249 + - *65 - 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. @@ -38030,8 +38673,8 @@ paths: maxItems: 50 items: type: string - - *38 - - *39 + - *43 + - *44 - *17 responses: '200': @@ -38040,7 +38683,7 @@ paths: application/json: schema: type: array - items: &250 + items: &256 title: Projects v2 Item description: An item belonging to a project type: object @@ -38057,7 +38700,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: *247 + content_type: *253 content: type: - object @@ -38107,7 +38750,7 @@ paths: - updated_at - archived_at examples: - default: &251 + default: &257 value: id: 13 node_id: PVTI_lAAFAQ0 @@ -38783,7 +39426,7 @@ paths: type: sub_issues_progress value: headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -38803,8 +39446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project parameters: - - *61 - - *243 + - *65 + - *249 requestBody: required: true description: Details of the item to add to the project. @@ -38841,10 +39484,10 @@ paths: description: Response content: application/json: - schema: *248 + schema: *254 examples: - issue: *249 - pull_request: *249 + issue: *255 + pull_request: *255 '304': *35 '403': *27 '401': *23 @@ -38864,9 +39507,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project parameters: - - *243 - - *61 - - &252 + - *249 + - *65 + - &258 name: item_id description: The unique identifier of the project item. in: path @@ -38892,11 +39535,11 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - default: *251 + default: *257 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -38915,9 +39558,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-organization parameters: - - *243 - - *61 - - *252 + - *249 + - *65 + - *258 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -38990,13 +39633,13 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - text_field: *251 - number_field: *251 - date_field: *251 - single_select_field: *251 - iteration_field: *251 + text_field: *257 + number_field: *257 + date_field: *257 + single_select_field: *257 + iteration_field: *257 '401': *23 '403': *27 '404': *6 @@ -39016,9 +39659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization parameters: - - *243 - - *61 - - *252 + - *249 + - *65 + - *258 responses: '204': description: Response @@ -39042,7 +39685,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Response @@ -39050,7 +39693,7 @@ paths: application/json: schema: type: array - items: &253 + items: &259 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -39124,7 +39767,7 @@ paths: - property_name - value_type examples: - default: &254 + default: &260 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39172,7 +39815,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *61 + - *65 requestBody: required: true content: @@ -39183,7 +39826,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *253 + items: *259 minItems: 1 maxItems: 100 required: @@ -39213,9 +39856,9 @@ paths: application/json: schema: type: array - items: *253 + items: *259 examples: - default: *254 + default: *260 '403': *27 '404': *6 x-github: @@ -39236,8 +39879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *61 - - &255 + - *65 + - &261 name: custom_property_name description: The custom property name in: path @@ -39249,9 +39892,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: &256 + default: &262 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -39285,8 +39928,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: - - *61 - - *255 + - *65 + - *261 requestBody: required: true content: @@ -39362,9 +40005,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *259 examples: - default: *256 + default: *262 '403': *27 '404': *6 x-github: @@ -39387,10 +40030,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *61 - - *255 + - *65 + - *261 responses: - '204': *168 + '204': *174 '403': *27 '404': *6 x-github: @@ -39411,7 +40054,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *61 + - *65 - *17 - *19 - name: repository_query @@ -39452,7 +40095,7 @@ paths: - octocat/Hello-World properties: type: array - items: *95 + items: *101 description: List of custom property names and associated values required: - repository_id @@ -39473,7 +40116,7 @@ paths: - property_name: team value: octocat headers: - Link: *52 + Link: *56 '403': *27 '404': *6 x-github: @@ -39501,7 +40144,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: - - *61 + - *65 requestBody: required: true content: @@ -39521,7 +40164,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *95 + items: *101 required: - repository_names - properties @@ -39562,7 +40205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *61 + - *65 - *17 - *19 responses: @@ -39574,9 +40217,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39593,8 +40236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response if user is a public member @@ -39618,8 +40261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -39640,8 +40283,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: + - *65 - *61 - - *57 responses: '204': description: Response @@ -39665,7 +40308,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *61 + - *65 - name: type description: Specifies the types of repositories you want returned. in: query @@ -39711,11 +40354,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39734,7 +40377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *61 + - *65 requestBody: required: true content: @@ -39916,7 +40559,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &319 title: Full Repository description: Full Repository type: object @@ -40262,7 +40905,7 @@ paths: template_repository: anyOf: - type: 'null' - - *64 + - *68 temp_clone_token: type: - string @@ -40362,13 +41005,13 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 organization: anyOf: - type: 'null' - *4 - parent: *64 - source: *64 + parent: *68 + source: *68 forks: type: integer master_branch: @@ -40381,7 +41024,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &448 + code_of_conduct: &452 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -40411,7 +41054,7 @@ paths: - key - name - html_url - security_and_analysis: *257 + security_and_analysis: *263 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -40495,7 +41138,7 @@ paths: - network_count - subscribers_count examples: - default: &319 + default: &321 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -41013,10 +41656,10 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - *17 - *19 - - &567 + - &570 name: targets description: | A comma-separated list of rule targets to filter by. @@ -41035,7 +41678,7 @@ paths: application/json: schema: type: array - items: &283 + items: &290 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -41070,7 +41713,7 @@ paths: source: type: string description: The name of the source - enforcement: &260 + enforcement: &266 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -41083,7 +41726,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &261 + items: &267 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -41154,7 +41797,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &258 + - &264 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -41178,7 +41821,7 @@ paths: match. items: type: string - - &262 + - &268 title: Organization ruleset conditions type: object description: |- @@ -41192,7 +41835,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *258 + - *264 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -41226,7 +41869,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *258 + - *264 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -41248,7 +41891,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *258 + - *264 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -41261,7 +41904,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &259 + items: &265 title: Repository ruleset property targeting definition type: object @@ -41294,7 +41937,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *259 + items: *265 required: - repository_property type: @@ -41302,12 +41945,12 @@ paths: - object rules: type: array - items: &568 + items: &571 title: Repository Rule type: object description: A repository rule. oneOf: - - &263 + - &269 title: creation description: Only allow users with bypass permission to create matching refs. @@ -41319,7 +41962,7 @@ paths: type: string enum: - creation - - &264 + - &270 title: update description: Only allow users with bypass permission to update matching refs. @@ -41340,7 +41983,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &265 + - &271 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -41352,7 +41995,7 @@ paths: type: string enum: - deletion - - &266 + - &272 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -41364,7 +42007,7 @@ paths: type: string enum: - required_linear_history - - &565 + - &569 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -41442,7 +42085,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &267 + - &273 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -41466,7 +42109,7 @@ paths: type: string required: - required_deployment_environments - - &268 + - &274 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -41478,7 +42121,7 @@ paths: type: string enum: - required_signatures - - &269 + - &275 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -41509,7 +42152,8 @@ paths: type: boolean description: Request Copilot code review for new pull requests automatically if the author has - access to Copilot code review. + access to Copilot code review and their premium + requests quota has not reached the limit. dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will @@ -41589,7 +42233,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &270 + - &276 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -41637,7 +42281,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &271 + - &277 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -41649,7 +42293,7 @@ paths: type: string enum: - non_fast_forward - - &272 + - &278 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -41685,7 +42329,7 @@ paths: required: - operator - pattern - - &273 + - &279 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -41721,7 +42365,7 @@ paths: required: - operator - pattern - - &274 + - &280 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -41757,7 +42401,7 @@ paths: required: - operator - pattern - - &275 + - &281 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -41793,7 +42437,7 @@ paths: required: - operator - pattern - - &276 + - &282 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -41829,7 +42473,7 @@ paths: required: - operator - pattern - - &277 + - &283 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit @@ -41854,7 +42498,7 @@ paths: type: string required: - restricted_file_paths - - &278 + - &284 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed @@ -41878,7 +42522,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &279 + - &285 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -41901,7 +42545,7 @@ paths: type: string required: - restricted_file_extensions - - &280 + - &286 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit @@ -41926,7 +42570,7 @@ paths: maximum: 100 required: - max_file_size - - &281 + - &287 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -41976,7 +42620,7 @@ paths: - repository_id required: - workflows - - &282 + - &288 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -42037,11 +42681,12 @@ paths: - tool required: - code_scanning_tools - - &566 + - &289 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code - review. + review and their premium requests quota has not reached + the limit. type: object required: - type @@ -42098,7 +42743,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -42114,7 +42759,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 requestBody: description: Request body required: true @@ -42135,26 +42780,20 @@ paths: - push - repository default: branch - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *262 + items: *267 + conditions: *268 rules: type: array description: An array of rules within the ruleset. - items: &285 + items: &292 title: Repository Rule type: object description: A repository rule. oneOf: - - *263 - - *264 - - *265 - - *266 - - *267 - - *268 - *269 - *270 - *271 @@ -42169,6 +42808,13 @@ paths: - *280 - *281 - *282 + - *283 + - *284 + - *285 + - *286 + - *287 + - *288 + - *289 required: - name - enforcement @@ -42206,9 +42852,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: &284 + default: &291 value: id: 21 name: super cool ruleset @@ -42248,7 +42894,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -42262,8 +42908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *61 - - &569 + - *65 + - &572 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 @@ -42278,7 +42924,7 @@ paths: in: query schema: type: string - - &570 + - &573 name: time_period description: |- The time period to filter by. @@ -42294,14 +42940,14 @@ paths: - week - month default: day - - &571 + - &574 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 + - &575 name: rule_suite_result description: The rule suite results to filter on. When specified, only suites with this result will be returned. @@ -42321,7 +42967,7 @@ paths: description: Response content: application/json: - schema: &573 + schema: &576 title: Rule Suites description: Response type: array @@ -42377,7 +43023,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &574 + default: &577 value: - id: 21 actor_id: 12 @@ -42401,7 +43047,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42420,8 +43066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *61 - - &575 + - *65 + - &578 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -42437,7 +43083,7 @@ paths: description: Response content: application/json: - schema: &576 + schema: &579 title: Rule Suite description: Response type: object @@ -42544,7 +43190,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &577 + default: &580 value: id: 21 actor_id: 12 @@ -42579,7 +43225,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42605,7 +43251,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42617,11 +43263,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *284 + default: *291 '404': *6 - '500': *96 + '500': *102 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -42637,7 +43283,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42663,16 +43309,16 @@ paths: - tag - push - repository - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *262 + items: *267 + conditions: *268 rules: description: An array of rules within the ruleset. type: array - items: *285 + items: *292 examples: default: value: @@ -42707,11 +43353,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *284 + default: *291 '404': *6 - '500': *96 + '500': *102 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -42727,7 +43373,7 @@ paths: category: orgs subcategory: rules parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42738,7 +43384,7 @@ paths: '204': description: Response '404': *6 - '500': *96 + '500': *102 "/orgs/{org}/rulesets/{ruleset_id}/history": get: summary: Get organization ruleset history @@ -42750,7 +43396,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history parameters: - - *61 + - *65 - *17 - *19 - name: ruleset_id @@ -42766,7 +43412,7 @@ paths: application/json: schema: type: array - items: &286 + items: &293 title: Ruleset version type: object description: The historical version of a ruleset @@ -42790,7 +43436,7 @@ paths: type: string format: date-time examples: - default: &579 + default: &582 value: - version_id: 3 actor: @@ -42808,7 +43454,7 @@ paths: type: User updated_at: '2024-08-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42825,7 +43471,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version parameters: - - *61 + - *65 - name: ruleset_id description: The ID of the ruleset. in: path @@ -42843,9 +43489,9 @@ paths: description: Response content: application/json: - schema: &580 + schema: &583 allOf: - - *286 + - *293 - type: object required: - state @@ -42892,7 +43538,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42914,8 +43560,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *61 - - &581 + - *65 + - &584 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -42926,7 +43572,7 @@ paths: enum: - open - resolved - - &582 + - &585 name: secret_type in: query description: A comma-separated list of secret types to return. All default @@ -42936,7 +43582,7 @@ paths: required: false schema: type: string - - &583 + - &586 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -42945,7 +43591,26 @@ paths: required: false schema: type: string - - &584 + - &587 + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts + assigned to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + - &588 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. @@ -42957,10 +43622,10 @@ paths: - created - updated default: created - - *46 + - *50 - *19 - *17 - - &585 + - &589 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 @@ -42970,7 +43635,7 @@ paths: required: false schema: type: string - - &586 + - &590 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 @@ -42980,7 +43645,7 @@ paths: required: false schema: type: string - - &587 + - &591 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -42989,7 +43654,7 @@ paths: required: false schema: type: string - - &588 + - &592 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -42998,7 +43663,7 @@ paths: schema: type: boolean default: false - - &589 + - &593 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -43007,7 +43672,7 @@ paths: schema: type: boolean default: false - - &590 + - &594 name: hide_secret in: query description: A boolean value representing whether or not to hide literal secrets @@ -43026,27 +43691,27 @@ paths: items: type: object properties: - number: *154 - created_at: *155 + number: *160 + created_at: *161 updated_at: anyOf: - type: 'null' - - *156 - url: *157 - html_url: *158 + - *162 + url: *163 + html_url: *164 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &591 + state: &595 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: &592 + resolution: &596 type: - string - 'null' @@ -43080,7 +43745,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *51 + repository: *55 push_protection_bypassed: type: - boolean @@ -43153,14 +43818,14 @@ paths: first_location_detected: anyOf: - type: 'null' - - &593 + - &597 description: 'Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. ' oneOf: - - &595 + - &599 description: Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. @@ -43217,7 +43882,7 @@ paths: - blob_url - commit_sha - commit_url - - &596 + - &600 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. @@ -43278,7 +43943,7 @@ paths: - page_url - commit_sha - commit_url - - &597 + - &601 description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -43293,7 +43958,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url - - &598 + - &602 description: Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. @@ -43308,7 +43973,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url - - &599 + - &603 description: Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. @@ -43323,7 +43988,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url - - &600 + - &604 description: Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. @@ -43338,7 +44003,7 @@ paths: - https://github.com/community/community/discussions/39082 required: - discussion_title_url - - &601 + - &605 description: Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. @@ -43353,7 +44018,7 @@ paths: - https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url - - &602 + - &606 description: Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. @@ -43368,7 +44033,7 @@ paths: - https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url - - &603 + - &607 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. @@ -43383,7 +44048,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_title_url - - &604 + - &608 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. @@ -43398,7 +44063,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846 required: - pull_request_body_url - - &605 + - &609 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. @@ -43413,7 +44078,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url - - &606 + - &610 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. @@ -43428,7 +44093,7 @@ paths: - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url - - &607 + - &611 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 @@ -43629,9 +44294,9 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43656,7 +44321,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *61 + - *65 responses: '200': description: Response @@ -43668,7 +44333,7 @@ paths: related to push protection. type: object properties: - pattern_config_version: &288 + pattern_config_version: &295 type: - string - 'null' @@ -43678,7 +44343,7 @@ paths: provider_pattern_overrides: type: array description: Overrides for partner patterns. - items: &287 + items: &294 type: object properties: token_type: @@ -43747,7 +44412,7 @@ paths: custom_pattern_overrides: type: array description: Overrides for custom patterns defined by the organization. - items: *287 + items: *294 examples: default: value: @@ -43796,7 +44461,7 @@ paths: category: secret-scanning subcategory: push-protection parameters: - - *61 + - *65 requestBody: required: true content: @@ -43804,7 +44469,7 @@ paths: schema: type: object properties: - pattern_config_version: *288 + pattern_config_version: *295 provider_pattern_settings: type: array description: Pattern settings for provider patterns. @@ -43830,7 +44495,7 @@ paths: token_type: type: string description: The ID of the pattern to configure. - custom_pattern_version: *288 + custom_pattern_version: *295 push_protection_setting: type: string description: Push protection setting to set for the pattern. @@ -43866,7 +44531,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *15 "/orgs/{org}/security-advisories": get: @@ -43884,8 +44549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *61 - - *46 + - *65 + - *50 - name: sort description: The property to sort the results by. in: query @@ -43897,8 +44562,8 @@ paths: - updated - published default: created - - *38 - - *39 + - *43 + - *44 - 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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -43928,7 +44593,7 @@ paths: application/json: schema: type: array - items: &611 + items: &615 description: A repository security advisory. type: object properties: @@ -44136,7 +44801,7 @@ paths: required: - vector_string - score - cvss_severities: *48 + cvss_severities: *52 cwes: type: - array @@ -44172,7 +44837,7 @@ paths: login: type: string description: The username of the user credited. - type: *289 + type: *296 credits_detailed: type: - array @@ -44183,7 +44848,7 @@ paths: type: object properties: user: *4 - type: *289 + type: *296 state: type: string description: The state of the user's acceptance of the @@ -44209,13 +44874,13 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *172 + items: *178 private_fork: readOnly: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *51 + - *55 type: - 'null' required: @@ -44247,7 +44912,7 @@ paths: - private_fork additionalProperties: false examples: - default: &612 + default: &616 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -44626,7 +45291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *61 + - *65 responses: '200': description: Response @@ -44634,9 +45299,9 @@ paths: application/json: schema: type: array - items: *223 + items: *229 examples: - default: *224 + default: *230 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44659,8 +45324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -44685,8 +45350,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -44713,7 +45378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - - *61 + - *65 responses: '200': description: Immutable releases settings response @@ -44763,7 +45428,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization parameters: - - *61 + - *65 responses: '204': description: Response @@ -44821,7 +45486,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - - *61 + - *65 - *19 - *17 responses: @@ -44839,9 +45504,9 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *148 + default: *154 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44860,7 +45525,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement parameters: - - *61 + - *65 requestBody: required: true content: @@ -44909,8 +45574,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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: Response @@ -44932,8 +45597,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: - - *61 - - *125 + - *65 + - *131 responses: '204': description: Response @@ -44956,7 +45621,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/network-configurations#list-hosted-compute-network-configurations-for-an-organization parameters: - - *61 + - *65 - *17 - *19 responses: @@ -44974,7 +45639,7 @@ paths: type: integer network_configurations: type: array - items: &290 + items: &297 title: Hosted compute network configuration description: A hosted compute network configuration. type: object @@ -45038,7 +45703,7 @@ paths: - 6789ABDCEF12345 created_on: '2023-04-26T15:23:37Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45057,7 +45722,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: - - *61 + - *65 requestBody: required: true content: @@ -45099,9 +45764,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *297 examples: - default: &291 + default: &298 value: id: 123456789ABCDEF name: My network configuration @@ -45129,8 +45794,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: - - *61 - - &292 + - *65 + - &299 name: network_configuration_id description: Unique identifier of the hosted compute network configuration. in: path @@ -45142,11 +45807,11 @@ paths: description: Response content: application/json: - schema: *290 + schema: *297 examples: - default: *291 + default: *298 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45165,8 +45830,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: - - *61 - - *292 + - *65 + - *299 requestBody: required: true content: @@ -45205,9 +45870,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *297 examples: - default: *291 + default: *298 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45226,8 +45891,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: - - *61 - - *292 + - *65 + - *299 responses: '204': description: Response @@ -45250,7 +45915,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: - - *61 + - *65 - name: network_settings_id description: Unique identifier of the hosted compute network settings. in: path @@ -45309,7 +45974,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45339,8 +46004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *61 - - *62 + - *65 + - *66 - 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`). @@ -45372,13 +46037,13 @@ paths: application/json: schema: type: array - items: *293 + items: *300 examples: - default: *294 - '500': *96 + default: *301 + '500': *102 '403': *27 '404': *6 - '422': *295 + '422': *302 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45396,7 +46061,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *61 + - *65 - *17 - *19 responses: @@ -45406,11 +46071,11 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 headers: - Link: *52 + Link: *56 '403': *27 x-github: githubCloudOnly: false @@ -45430,7 +46095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *61 + - *65 requestBody: required: true content: @@ -45502,7 +46167,7 @@ paths: description: Response content: application/json: - schema: &296 + schema: &303 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -45576,7 +46241,7 @@ paths: parent: anyOf: - type: 'null' - - *223 + - *229 members_count: type: integer examples: @@ -45901,7 +46566,7 @@ paths: - repos_count - organization examples: - default: &297 + default: &304 value: id: 1 node_id: MDQ6VGVhbTE= @@ -45971,16 +46636,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *61 - - *62 + - *65 + - *66 responses: '200': description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -46001,8 +46666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *61 - - *62 + - *65 + - *66 requestBody: required: false content: @@ -46065,16 +46730,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '201': description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 '422': *15 '403': *27 @@ -46099,8 +46764,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *61 - - *62 + - *65 + - *66 responses: '204': description: Response @@ -46126,9 +46791,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *61 - - *62 - - *46 + - *65 + - *66 + - *50 - *17 - *19 - name: pinned @@ -46144,7 +46809,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -46235,7 +46900,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *66 + reactions: *70 required: - author - body @@ -46255,7 +46920,7 @@ paths: - updated_at - url examples: - default: &629 + default: &633 value: - author: login: octocat @@ -46305,7 +46970,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46329,8 +46994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *61 - - *62 + - *65 + - *66 requestBody: required: true content: @@ -46364,9 +47029,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &299 + default: &306 value: author: login: octocat @@ -46438,9 +47103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *61 - - *62 - - &300 + - *65 + - *66 + - &307 name: discussion_number description: The number that identifies the discussion. in: path @@ -46452,9 +47117,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46476,9 +47141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 requestBody: required: false content: @@ -46501,9 +47166,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &630 + default: &634 value: author: login: octocat @@ -46573,9 +47238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 responses: '204': description: Response @@ -46601,10 +47266,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *61 - - *62 - - *300 - - *46 + - *65 + - *66 + - *307 + - *50 - *17 - *19 responses: @@ -46614,7 +47279,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -46679,7 +47344,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *66 + reactions: *70 required: - author - body @@ -46694,7 +47359,7 @@ paths: - updated_at - url examples: - default: &631 + default: &635 value: - author: login: octocat @@ -46738,7 +47403,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46762,9 +47427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 requestBody: required: true content: @@ -46786,9 +47451,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: &302 + default: &309 value: author: login: octocat @@ -46854,10 +47519,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *61 - - *62 - - *300 - - &303 + - *65 + - *66 + - *307 + - &310 name: comment_number description: The number that identifies the comment. in: path @@ -46869,9 +47534,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46893,10 +47558,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 requestBody: required: true content: @@ -46918,9 +47583,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: &632 + default: &636 value: author: login: octocat @@ -46984,10 +47649,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 responses: '204': description: Response @@ -47013,10 +47678,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 - 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. @@ -47042,7 +47707,7 @@ paths: application/json: schema: type: array - items: &304 + items: &311 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -47086,7 +47751,7 @@ paths: - content - created_at examples: - default: &306 + default: &313 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -47112,7 +47777,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47136,10 +47801,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *61 - - *62 - - *300 - - *303 + - *65 + - *66 + - *307 + - *310 requestBody: required: true content: @@ -47172,9 +47837,9 @@ paths: team discussion comment content: application/json: - schema: *304 + schema: *311 examples: - default: &305 + default: &312 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -47203,9 +47868,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47228,11 +47893,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *61 - - *62 - - *300 - - *303 - - &307 + - *65 + - *66 + - *307 + - *310 + - &314 name: reaction_id description: The unique identifier of the reaction. in: path @@ -47264,9 +47929,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 - 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. @@ -47292,11 +47957,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47320,9 +47985,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *61 - - *62 - - *300 + - *65 + - *66 + - *307 requestBody: required: true content: @@ -47354,16 +48019,16 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -47386,10 +48051,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *61 - - *62 - - *300 + - *65 + - *66 - *307 + - *314 responses: '204': description: Response @@ -47413,8 +48078,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *61 - - *62 + - *65 + - *66 - *17 - *19 responses: @@ -47424,11 +48089,11 @@ paths: application/json: schema: type: array - items: *205 + items: *211 examples: - default: *206 + default: *212 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47448,8 +48113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *61 - - *62 + - *65 + - *66 - name: role description: Filters members returned by their role in the team. in: query @@ -47472,9 +48137,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47502,15 +48167,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: + - *65 + - *66 - *61 - - *62 - - *57 responses: '200': description: Response content: application/json: - schema: &308 + schema: &315 title: Team Membership description: Team Membership type: object @@ -47538,7 +48203,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &633 + response-if-user-is-a-team-maintainer: &637 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -47574,9 +48239,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: + - *65 + - *66 - *61 - - *62 - - *57 requestBody: required: false content: @@ -47601,9 +48266,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - response-if-users-membership-with-team-is-now-pending: &634 + response-if-users-membership-with-team-is-now-pending: &638 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -47638,9 +48303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: + - *65 + - *66 - *61 - - *62 - - *57 responses: '204': description: Response @@ -47651,324 +48316,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - *61 - - *62 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &309 - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: - - string - - 'null' - number: - type: integer - state: - type: string - creator: *4 - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only - present when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present - when owner is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - examples: - default: &635 - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - headers: - Link: *52 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - *61 - - *62 - - &310 - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: *309 - examples: - default: &636 - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - put: - summary: Add or update team project permissions - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - *61 - - *62 - - *310 - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove a project from a team - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - *61 - - *62 - - *310 - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -47984,8 +48331,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *61 - - *62 + - *65 + - *66 - *17 - *19 responses: @@ -47995,11 +48342,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48026,16 +48373,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *61 - - *62 - - *311 - - *312 + - *65 + - *66 + - *316 + - *317 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &637 + schema: &639 title: Team Repository description: A team's access to a repository. type: object @@ -48061,7 +48408,7 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 forks: type: integer permissions: @@ -48676,10 +49023,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *61 - - *62 - - *311 - - *312 + - *65 + - *66 + - *316 + - *317 requestBody: required: false content: @@ -48724,10 +49071,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *61 - - *62 - - *311 - - *312 + - *65 + - *66 + - *316 + - *317 responses: '204': description: Response @@ -48751,8 +49098,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *61 - - *62 + - *65 + - *66 - *17 - *19 responses: @@ -48762,9 +49109,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - response-if-child-teams-exist: &638 + response-if-child-teams-exist: &640 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -48792,7 +49139,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48817,7 +49164,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *61 + - *65 - name: security_product in: path description: The security feature to enable or disable. @@ -48877,464 +49224,6 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#get-a-project-column - parameters: - - &313 - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer - responses: - '200': - description: Response - content: - application/json: - schema: &314 - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - examples: - - https://api.github.com/projects/120 - cards_url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - type: integer - examples: - - 42 - node_id: - type: string - examples: - - MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - created_at: - type: string - format: date-time - examples: - - '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - examples: - - '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - examples: - default: &315 - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': *35 - '403': *27 - '404': *6 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - patch: - summary: Update an existing project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#update-an-existing-project-column - parameters: - - *313 - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: *314 - examples: - default: *315 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Delete a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#delete-a-project-column - parameters: - - *313 - responses: - '204': - description: Response - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/columns#move-a-project-column - parameters: - - *313 - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - type: string - pattern: "^(?:first|last|after:\\d+)$" - examples: - - last - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': *35 - '403': *27 - '422': *7 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: columns - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#list-project-collaborators - parameters: - - *310 - - 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 - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *4 - examples: - default: *56 - headers: - Link: *52 - '404': *6 - '422': *15 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#add-project-collaborator - parameters: - - *310 - - *57 - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - type: string - examples: - - write - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': *6 - '422': *15 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - delete: - summary: Remove user as a collaborator - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#remove-user-as-a-collaborator - parameters: - - *310 - - *57 - responses: - '204': - description: Response - '304': *35 - '404': *6 - '403': *27 - '422': *15 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - projects-classic - operationId: projects-classic/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects-classic/collaborators#get-project-permission-for-a-user - parameters: - - *310 - - *57 - responses: - '200': - description: Response - content: - application/json: - schema: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - anyOf: - - type: 'null' - - *4 - required: - - permission - - user - examples: - default: - value: - permission: admin - user: - 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 - '404': *6 - '422': *15 - '304': *35 - '403': *27 - '401': *23 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects-classic - subcategory: collaborators - deprecationDate: '2024-05-23' - removalDate: '2025-04-01' - deprecated: true "/rate_limit": get: summary: Get rate limit status for the authenticated user @@ -49376,7 +49265,7 @@ paths: resources: type: object properties: - core: &316 + core: &318 title: Rate Limit type: object properties: @@ -49393,21 +49282,21 @@ paths: - remaining - reset - used - 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 + graphql: *318 + search: *318 + code_search: *318 + source_import: *318 + integration_manifest: *318 + code_scanning_upload: *318 + actions_runner_registration: *318 + scim: *318 + dependency_snapshots: *318 + dependency_sbom: *318 + code_scanning_autofix: *318 required: - core - search - rate: *316 + rate: *318 required: - rate - resources @@ -49512,14 +49401,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *317 + schema: *319 examples: default-response: summary: Default response @@ -50020,7 +49909,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *318 + '301': *320 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50038,8 +49927,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -50287,10 +50176,10 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 - '307': &320 + default: *321 + '307': &322 description: Temporary Redirect content: application/json: @@ -50319,8 +50208,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -50342,9 +50231,9 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *320 + '307': *322 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50366,11 +50255,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - - &351 + - &355 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -50393,7 +50282,7 @@ paths: type: integer artifacts: type: array - items: &321 + items: &323 title: Artifact description: An artifact type: object @@ -50488,7 +50377,7 @@ paths: - expires_at - updated_at examples: - default: &352 + default: &356 value: total_count: 2 artifacts: @@ -50527,7 +50416,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50549,9 +50438,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *311 - - *312 - - &322 + - *316 + - *317 + - &324 name: artifact_id description: The unique identifier of the artifact. in: path @@ -50563,7 +50452,7 @@ paths: description: Response content: application/json: - schema: *321 + schema: *323 examples: default: value: @@ -50601,9 +50490,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *311 - - *312 - - *322 + - *316 + - *317 + - *324 responses: '204': description: Response @@ -50627,9 +50516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *311 - - *312 - - *322 + - *316 + - *317 + - *324 - name: archive_format in: path required: true @@ -50643,7 +50532,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': &502 + '410': &506 description: Gone content: application/json: @@ -50653,6 +50542,158 @@ paths: enabledForGitHubApps: true category: actions subcategory: artifacts + "/repos/{owner}/{repo}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - *316 + - *317 + responses: + '200': + description: Response + content: + application/json: + schema: &325 + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this + repository. + type: integer + examples: + - 14 + examples: + default: *40 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - *316 + - *317 + requestBody: + required: true + content: + application/json: + schema: *325 + examples: + selected_actions: *40 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/repos/{owner}/{repo}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - *316 + - *317 + responses: + '200': + description: Response + content: + application/json: + schema: &326 + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, + in gigabytes. + type: integer + examples: + - 10 + examples: + default: *42 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - *316 + - *317 + requestBody: + required: true + content: + application/json: + schema: *326 + examples: + selected_actions: *42 + responses: + '204': + description: Response + '400': *14 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository @@ -50670,14 +50711,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *323 + schema: *327 examples: default: value: @@ -50703,11 +50744,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - - &324 + - &328 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 @@ -50735,13 +50776,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *46 + - *50 responses: '200': description: Response content: application/json: - schema: &325 + schema: &329 title: Repository actions caches description: Repository actions caches type: object @@ -50791,7 +50832,7 @@ paths: - total_count - actions_caches examples: - default: &326 + default: &330 value: total_count: 1 actions_caches: @@ -50803,7 +50844,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50823,23 +50864,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: - - *311 - - *312 + - *316 + - *317 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *324 + - *328 responses: '200': description: Response content: application/json: - schema: *325 + schema: *329 examples: - default: *326 + default: *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50859,8 +50900,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: - - *311 - - *312 + - *316 + - *317 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -50891,9 +50932,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *311 - - *312 - - &327 + - *316 + - *317 + - &331 name: job_id description: The unique identifier of the job. in: path @@ -50905,7 +50946,7 @@ paths: description: Response content: application/json: - schema: &355 + schema: &359 title: Job description: Information of a job execution in a workflow run type: object @@ -51252,9 +51293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *311 - - *312 - - *327 + - *316 + - *317 + - *331 responses: '302': description: Response @@ -51282,9 +51323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *311 - - *312 - - *327 + - *316 + - *317 + - *331 requestBody: required: false content: @@ -51306,7 +51347,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -51330,8 +51371,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Status response @@ -51381,8 +51422,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -51416,7 +51457,7 @@ paths: description: Empty response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -51445,8 +51486,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -51464,7 +51505,7 @@ paths: type: integer secrets: type: array - items: &357 + items: &361 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -51485,7 +51526,7 @@ paths: - created_at - updated_at examples: - default: &358 + default: &362 value: total_count: 2 secrets: @@ -51496,7 +51537,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51518,9 +51559,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *311 - - *312 - - *328 + - *316 + - *317 + - *332 - *19 responses: '200': @@ -51537,7 +51578,7 @@ paths: type: integer variables: type: array - items: &361 + items: &365 title: Actions Variable type: object properties: @@ -51571,7 +51612,7 @@ paths: - created_at - updated_at examples: - default: &362 + default: &366 value: total_count: 2 variables: @@ -51584,7 +51625,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51604,8 +51645,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -51614,12 +51655,12 @@ paths: schema: type: object properties: - enabled: &330 + enabled: &334 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *121 - selected_actions_url: *329 - sha_pinning_required: *122 + allowed_actions: *127 + selected_actions_url: *333 + sha_pinning_required: *128 required: - enabled examples: @@ -51647,8 +51688,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -51659,9 +51700,9 @@ paths: schema: type: object properties: - enabled: *330 - allowed_actions: *121 - sha_pinning_required: *122 + enabled: *334 + allowed_actions: *127 + sha_pinning_required: *128 required: - enabled examples: @@ -51691,14 +51732,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: &331 + schema: &335 type: object properties: access_level: @@ -51715,7 +51756,7 @@ paths: required: - access_level examples: - default: &332 + default: &336 value: access_level: organization x-github: @@ -51739,15 +51780,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: application/json: - schema: *331 + schema: *335 examples: - default: *332 + default: *336 responses: '204': description: Response @@ -51771,14 +51812,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *333 + schema: *337 examples: default: value: @@ -51802,8 +51843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Empty response for successful settings update @@ -51813,7 +51854,7 @@ paths: required: true content: application/json: - schema: *334 + schema: *338 examples: default: summary: Set retention days @@ -51837,16 +51878,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *123 + schema: *129 examples: - default: *335 + default: *339 '404': *6 x-github: enabledForGitHubApps: true @@ -51865,8 +51906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -51876,7 +51917,7 @@ paths: required: true content: application/json: - schema: *123 + schema: *129 examples: default: summary: Set approval policy to first time contributors @@ -51900,16 +51941,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *336 + schema: *340 examples: - default: *124 + default: *130 '403': *27 '404': *6 x-github: @@ -51929,15 +51970,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: application/json: - schema: *337 + schema: *341 examples: - default: *124 + default: *130 responses: '204': description: Empty response for successful settings update @@ -51961,16 +52002,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *126 + schema: *132 examples: - default: *127 + default: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51989,8 +52030,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -51998,9 +52039,9 @@ paths: required: false content: application/json: - schema: *126 + schema: *132 examples: - selected_actions: *127 + selected_actions: *133 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52022,16 +52063,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *338 + schema: *342 examples: - default: *131 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52052,8 +52093,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Success response @@ -52064,9 +52105,9 @@ paths: required: true content: application/json: - schema: *339 + schema: *343 examples: - default: *131 + default: *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52093,8 +52134,8 @@ paths: in: query schema: type: string - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -52112,11 +52153,11 @@ paths: type: integer runners: type: array - items: *138 + items: *144 examples: - default: *139 + default: *145 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52138,8 +52179,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -52147,9 +52188,9 @@ paths: application/json: schema: type: array - items: *340 + items: *344 examples: - default: *341 + default: *345 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52171,8 +52212,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -52215,10 +52256,10 @@ paths: - no-gpu work_folder: _work responses: - '201': *342 + '201': *346 '404': *6 '422': *7 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52246,16 +52287,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '201': description: Response content: application/json: - schema: *140 + schema: *146 examples: - default: *343 + default: *347 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52283,16 +52324,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '201': description: Response content: application/json: - schema: *140 + schema: *146 examples: - default: *344 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52314,17 +52355,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: '200': description: Response content: application/json: - schema: *138 + schema: *144 examples: - default: *345 + default: *349 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52345,9 +52386,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: '204': description: Response @@ -52373,11 +52414,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: - '200': *142 + '200': *148 '404': *6 x-github: githubCloudOnly: false @@ -52399,9 +52440,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 requestBody: required: true content: @@ -52425,7 +52466,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -52449,9 +52490,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 requestBody: required: true content: @@ -52476,7 +52517,7 @@ paths: - gpu - accelerated responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -52500,11 +52541,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: - - *311 - - *312 - - *137 + - *316 + - *317 + - *143 responses: - '200': *346 + '200': *350 '404': *6 x-github: githubCloudOnly: false @@ -52531,12 +52572,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: - - *311 - - *312 - - *137 - - *347 + - *316 + - *317 + - *143 + - *351 responses: - '200': *142 + '200': *148 '404': *6 '422': *7 x-github: @@ -52562,9 +52603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *311 - - *312 - - &365 + - *316 + - *317 + - &369 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. @@ -52572,7 +52613,7 @@ paths: required: false schema: type: string - - &366 + - &370 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -52580,7 +52621,7 @@ paths: required: false schema: type: string - - &367 + - &371 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -52589,7 +52630,7 @@ paths: required: false schema: type: string - - &368 + - &372 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 @@ -52616,7 +52657,7 @@ paths: - pending - *17 - *19 - - &369 + - &373 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)." @@ -52625,7 +52666,7 @@ paths: schema: type: string format: date-time - - &348 + - &352 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -52634,13 +52675,13 @@ paths: schema: type: boolean default: false - - &370 + - &374 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &371 + - &375 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -52663,7 +52704,7 @@ paths: type: integer workflow_runs: type: array - items: &349 + items: &353 title: Workflow Run description: An invocation of a workflow type: object @@ -52780,7 +52821,7 @@ paths: type: - array - 'null' - items: &390 + items: &394 title: Pull Request Minimal type: object properties: @@ -52907,7 +52948,7 @@ paths: head_commit: anyOf: - type: 'null' - - &394 + - &398 title: Simple Commit description: A commit. type: object @@ -52981,8 +53022,8 @@ paths: - timestamp - author - committer - repository: *136 - head_repository: *136 + repository: *142 + head_repository: *142 head_repository_id: type: integer examples: @@ -53022,7 +53063,7 @@ paths: - workflow_url - pull_requests examples: - default: &372 + default: &376 value: total_count: 1 workflow_runs: @@ -53236,7 +53277,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53258,24 +53299,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *311 - - *312 - - &350 + - *316 + - *317 + - &354 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *348 + - *352 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: &353 + default: &357 value: id: 30433642 name: Build @@ -53516,9 +53557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '204': description: Response @@ -53541,9 +53582,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '200': description: Response @@ -53671,15 +53712,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: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -53706,12 +53747,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 - *17 - *19 - - *351 + - *355 responses: '200': description: Response @@ -53727,11 +53768,11 @@ paths: type: integer artifacts: type: array - items: *321 + items: *323 examples: - default: *352 + default: *356 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53753,25 +53794,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *311 - - *312 - - *350 - - &354 + - *316 + - *317 + - *354 + - &358 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *348 + - *352 responses: '200': description: Response content: application/json: - schema: *349 + schema: *353 examples: - default: *353 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53794,10 +53835,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *311 - - *312 - - *350 + - *316 + - *317 - *354 + - *358 - *17 - *19 responses: @@ -53815,9 +53856,9 @@ paths: type: integer jobs: type: array - items: *355 + items: *359 examples: - default: &356 + default: &360 value: total_count: 1 jobs: @@ -53906,7 +53947,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -53930,10 +53971,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *311 - - *312 - - *350 + - *316 + - *317 - *354 + - *358 responses: '302': description: Response @@ -53961,19 +54002,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '202': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53996,9 +54037,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: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: true content: @@ -54065,19 +54106,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '202': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54100,9 +54141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 - 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 @@ -54132,11 +54173,11 @@ paths: type: integer jobs: type: array - items: *355 + items: *359 examples: - default: *356 + default: *360 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54159,9 +54200,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '302': description: Response @@ -54188,14 +54229,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '204': description: Response '403': *27 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54217,9 +54258,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '200': description: Response @@ -54288,7 +54329,7 @@ paths: items: type: object properties: - type: &468 + type: &472 type: string description: The type of reviewer. enum: @@ -54299,7 +54340,7 @@ paths: reviewer: anyOf: - *4 - - *172 + - *178 required: - environment - wait_timer @@ -54374,9 +54415,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: true content: @@ -54426,7 +54467,7 @@ paths: application/json: schema: type: array - items: &463 + items: &467 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -54538,7 +54579,7 @@ paths: - created_at - updated_at examples: - default: &464 + default: &468 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -54594,9 +54635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: false content: @@ -54618,7 +54659,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -54641,9 +54682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 requestBody: required: false content: @@ -54665,7 +54706,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -54697,9 +54738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *311 - - *312 - - *350 + - *316 + - *317 + - *354 responses: '200': description: Response @@ -54836,8 +54877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -54855,11 +54896,11 @@ paths: type: integer secrets: type: array - items: *357 + items: *361 examples: - default: *358 + default: *362 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54882,16 +54923,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54913,17 +54954,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '200': description: Response content: application/json: - schema: *357 + schema: *361 examples: - default: &481 + default: &485 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -54949,9 +54990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 requestBody: required: true content: @@ -54982,7 +55023,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -55008,9 +55049,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '204': description: Response @@ -55035,9 +55076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *311 - - *312 - - *328 + - *316 + - *317 + - *332 - *19 responses: '200': @@ -55054,11 +55095,11 @@ paths: type: integer variables: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55079,8 +55120,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -55107,7 +55148,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -55132,17 +55173,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *311 - - *312 - - *147 + - *316 + - *317 + - *153 responses: '200': description: Response content: application/json: - schema: *361 + schema: *365 examples: - default: &482 + default: &486 value: name: USERNAME value: octocat @@ -55168,9 +55209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *311 - - *312 - - *147 + - *316 + - *317 + - *153 requestBody: required: true content: @@ -55212,9 +55253,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *311 - - *312 - - *147 + - *316 + - *317 + - *153 responses: '204': description: Response @@ -55239,8 +55280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -55258,7 +55299,7 @@ paths: type: integer workflows: type: array - items: &363 + items: &367 title: Workflow description: A GitHub Actions workflow type: object @@ -55353,7 +55394,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55376,9 +55417,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *311 - - *312 - - &364 + - *316 + - *317 + - &368 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -55393,7 +55434,7 @@ paths: description: Response content: application/json: - schema: *363 + schema: *367 examples: default: value: @@ -55426,9 +55467,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '204': description: Response @@ -55453,9 +55494,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '204': description: Response @@ -55506,9 +55547,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '204': description: Response @@ -55535,19 +55576,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *311 - - *312 - - *364 - - *365 - - *366 - - *367 + - *316 + - *317 - *368 - - *17 - - *19 - *369 - - *348 - *370 - *371 + - *372 + - *17 + - *19 + - *373 + - *352 + - *374 + - *375 responses: '200': description: Response @@ -55563,11 +55604,11 @@ paths: type: integer workflow_runs: type: array - items: *349 + items: *353 examples: - default: *372 + default: *376 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55597,9 +55638,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *311 - - *312 - - *364 + - *316 + - *317 + - *368 responses: '200': description: Response @@ -55660,12 +55701,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *311 - - *312 - - *46 + - *316 + - *317 + - *50 - *17 - - *38 - - *39 + - *43 + - *44 - name: ref description: |- The Git reference for the activities you want to list. @@ -55810,7 +55851,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '422': *7 x-github: githubCloudOnly: false @@ -55829,8 +55870,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -55842,9 +55883,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -55867,8 +55908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *311 - - *312 + - *316 + - *317 - name: assignee in: path required: true @@ -55904,8 +55945,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -56017,11 +56058,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *311 - - *312 + - *316 + - *317 - *17 - - *38 - - *39 + - *43 + - *44 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -56075,7 +56116,7 @@ paths: initiator: type: string examples: - default: *373 + default: *377 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56095,8 +56136,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -56104,7 +56145,7 @@ paths: application/json: schema: type: array - items: &374 + items: &378 title: Autolink reference description: An autolink reference. type: object @@ -56163,8 +56204,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -56203,9 +56244,9 @@ paths: description: response content: application/json: - schema: *374 + schema: *378 examples: - default: &375 + default: &379 value: id: 1 key_prefix: TICKET- @@ -56236,9 +56277,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *311 - - *312 - - &376 + - *316 + - *317 + - &380 name: autolink_id description: The unique identifier of the autolink. in: path @@ -56250,9 +56291,9 @@ paths: description: Response content: application/json: - schema: *374 + schema: *378 examples: - default: *375 + default: *379 '404': *6 x-github: githubCloudOnly: false @@ -56272,9 +56313,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *311 - - *312 - - *376 + - *316 + - *317 + - *380 responses: '204': description: Response @@ -56298,8 +56339,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response if Dependabot is enabled @@ -56349,8 +56390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-dependabot-security-updates parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -56371,8 +56412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-dependabot-security-updates parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -56392,8 +56433,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *311 - - *312 + - *316 + - *317 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -56431,7 +56472,7 @@ paths: - url protected: type: boolean - protection: &378 + protection: &382 title: Branch Protection description: Branch Protection type: object @@ -56474,7 +56515,7 @@ paths: required: - contexts - checks - enforce_admins: &381 + enforce_admins: &385 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -56491,7 +56532,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &383 + required_pull_request_reviews: &387 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -56513,7 +56554,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *172 + items: *178 apps: description: The list of apps with review dismissal access. @@ -56545,7 +56586,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *172 + items: *178 apps: description: The list of apps allowed to bypass pull request requirements. @@ -56575,7 +56616,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &380 + restrictions: &384 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -56638,7 +56679,7 @@ paths: type: string teams: type: array - items: *172 + items: *178 apps: type: array items: @@ -56850,7 +56891,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -56868,9 +56909,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *311 - - *312 - - &379 + - *316 + - *317 + - &383 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). @@ -56884,14 +56925,14 @@ paths: description: Response content: application/json: - schema: &389 + schema: &393 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &439 + commit: &443 title: Commit description: Commit type: object @@ -56930,7 +56971,7 @@ paths: author: anyOf: - type: 'null' - - &377 + - &381 title: Git User description: Metaproperties for Git author/committer information. @@ -56946,12 +56987,13 @@ paths: - '"chris@ozmm.org"' date: type: string + format: date-time examples: - '"2007-10-29T02:42:39.000-07:00"' committer: anyOf: - type: 'null' - - *377 + - *381 message: type: string examples: @@ -56975,7 +57017,7 @@ paths: required: - sha - url - verification: &488 + verification: &492 title: Verification type: object properties: @@ -57011,14 +57053,14 @@ paths: author: oneOf: - *4 - - *145 + - *151 type: - 'null' - object committer: oneOf: - *4 - - *145 + - *151 type: - 'null' - object @@ -57055,7 +57097,7 @@ paths: type: integer files: type: array - items: &450 + items: &454 title: Diff Entry description: Diff Entry type: object @@ -57151,7 +57193,7 @@ paths: - self protected: type: boolean - protection: *378 + protection: *382 protection_url: type: string format: uri @@ -57260,7 +57302,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *318 + '301': *320 '404': *6 x-github: githubCloudOnly: false @@ -57282,15 +57324,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *378 + schema: *382 examples: default: value: @@ -57484,9 +57526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -57746,7 +57788,7 @@ paths: url: type: string format: uri - required_status_checks: &386 + required_status_checks: &390 title: Status Check Policy description: Status Check Policy type: object @@ -57827,7 +57869,7 @@ paths: items: *4 teams: type: array - items: *172 + items: *178 apps: type: array items: *5 @@ -57845,7 +57887,7 @@ paths: items: *4 teams: type: array - items: *172 + items: *178 apps: type: array items: *5 @@ -57905,7 +57947,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *380 + restrictions: *384 required_conversation_resolution: type: object properties: @@ -58017,9 +58059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58044,17 +58086,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: &382 + default: &386 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -58076,17 +58118,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *382 + default: *386 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58105,9 +58147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58132,17 +58174,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *383 + schema: *387 examples: - default: &384 + default: &388 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -58238,9 +58280,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58338,9 +58380,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *387 examples: - default: *384 + default: *388 '422': *15 x-github: githubCloudOnly: false @@ -58361,9 +58403,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58390,17 +58432,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: &385 + default: &389 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -58423,17 +58465,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *381 + schema: *385 examples: - default: *385 + default: *389 '404': *6 x-github: githubCloudOnly: false @@ -58453,9 +58495,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58480,17 +58522,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *386 + schema: *390 examples: - default: &387 + default: &391 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -58516,9 +58558,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58570,9 +58612,9 @@ paths: description: Response content: application/json: - schema: *386 + schema: *390 examples: - default: *387 + default: *391 '404': *6 '422': *15 x-github: @@ -58594,9 +58636,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58620,9 +58662,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -58656,9 +58698,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58725,9 +58767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -58791,9 +58833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: content: application/json: @@ -58859,15 +58901,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response content: application/json: - schema: *380 + schema: *384 examples: default: value: @@ -58958,9 +59000,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '204': description: Response @@ -58983,9 +59025,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -58995,7 +59037,7 @@ paths: type: array items: *5 examples: - default: &388 + default: &392 value: - id: 1 slug: octoapp @@ -59052,9 +59094,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59088,7 +59130,7 @@ paths: type: array items: *5 examples: - default: *388 + default: *392 '422': *15 x-github: githubCloudOnly: false @@ -59109,9 +59151,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59145,7 +59187,7 @@ paths: type: array items: *5 examples: - default: *388 + default: *392 '422': *15 x-github: githubCloudOnly: false @@ -59166,9 +59208,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59202,7 +59244,7 @@ paths: type: array items: *5 examples: - default: *388 + default: *392 '422': *15 x-github: githubCloudOnly: false @@ -59224,9 +59266,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -59234,9 +59276,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '404': *6 x-github: githubCloudOnly: false @@ -59256,9 +59298,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -59294,9 +59336,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '422': *15 x-github: githubCloudOnly: false @@ -59317,9 +59359,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: false content: @@ -59355,9 +59397,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '422': *15 x-github: githubCloudOnly: false @@ -59378,9 +59420,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: content: application/json: @@ -59415,9 +59457,9 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 '422': *15 x-github: githubCloudOnly: false @@ -59439,9 +59481,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 responses: '200': description: Response @@ -59451,7 +59493,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '404': *6 x-github: githubCloudOnly: false @@ -59475,9 +59517,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59510,7 +59552,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '422': *15 x-github: githubCloudOnly: false @@ -59535,9 +59577,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59570,7 +59612,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '422': *15 x-github: githubCloudOnly: false @@ -59595,9 +59637,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59630,7 +59672,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '422': *15 x-github: githubCloudOnly: false @@ -59657,9 +59699,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 requestBody: required: true content: @@ -59681,7 +59723,7 @@ paths: description: Response content: application/json: - schema: *389 + schema: *393 examples: default: value: @@ -59797,8 +59839,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -60077,7 +60119,7 @@ paths: description: Response content: application/json: - schema: &391 + schema: &395 title: CheckRun description: A check performed on the code of a given code change type: object @@ -60212,8 +60254,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *390 - deployment: &689 + items: *394 + deployment: &700 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -60500,9 +60542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *311 - - *312 - - &392 + - *316 + - *317 + - &396 name: check_run_id description: The unique identifier of the check run. in: path @@ -60514,9 +60556,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *395 examples: - default: &393 + default: &397 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -60616,9 +60658,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *311 - - *312 - - *392 + - *316 + - *317 + - *396 requestBody: required: true content: @@ -60858,9 +60900,9 @@ paths: description: Response content: application/json: - schema: *391 + schema: *395 examples: - default: *393 + default: *397 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60880,9 +60922,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *311 - - *312 - - *392 + - *316 + - *317 + - *396 - *17 - *19 responses: @@ -60972,7 +61014,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60992,15 +61034,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *311 - - *312 - - *392 + - *316 + - *317 + - *396 responses: '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -61038,8 +61080,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -61061,7 +61103,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &395 + schema: &399 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -61143,12 +61185,12 @@ paths: type: - array - 'null' - items: *390 + items: *394 app: anyOf: - type: 'null' - *5 - repository: *136 + repository: *142 created_at: type: - string @@ -61159,7 +61201,7 @@ paths: - string - 'null' format: date-time - head_commit: *394 + head_commit: *398 latest_check_runs_count: type: integer check_runs_url: @@ -61187,7 +61229,7 @@ paths: - check_runs_url - pull_requests examples: - default: &396 + default: &400 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -61478,9 +61520,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *395 + schema: *399 examples: - default: *396 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61499,8 +61541,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -61561,7 +61603,7 @@ paths: required: - app_id - setting - repository: *136 + repository: *142 examples: default: value: @@ -61809,9 +61851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *311 - - *312 - - &397 + - *316 + - *317 + - &401 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -61823,9 +61865,9 @@ paths: description: Response content: application/json: - schema: *395 + schema: *399 examples: - default: *396 + default: *400 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61848,17 +61890,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *311 - - *312 - - *397 - - &445 + - *316 + - *317 + - *401 + - &449 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &446 + - &450 name: status description: Returns check runs with the specified `status`. in: query @@ -61897,9 +61939,9 @@ paths: type: integer check_runs: type: array - items: *391 + items: *395 examples: - default: &447 + default: &451 value: total_count: 1 check_runs: @@ -61981,7 +62023,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62001,15 +62043,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *311 - - *312 - - *397 + - *316 + - *317 + - *401 responses: '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -62036,30 +62078,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *311 - - *312 - - *398 - - *399 + - *316 + - *317 + - *402 + - *403 - *19 - *17 - - &416 + - &420 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: *400 - - &417 + schema: *404 + - &421 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *46 - - *38 - - *39 + - *50 + - *43 + - *44 - name: sort description: The property by which to sort the results. in: query @@ -62075,13 +62117,13 @@ paths: be returned. in: query required: false - schema: *401 + schema: *405 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *402 + schema: *406 responses: '200': description: Response @@ -62092,24 +62134,24 @@ paths: items: type: object properties: - number: *154 - created_at: *155 - updated_at: *156 - url: *157 - html_url: *158 - instances_url: *403 - state: *163 - fixed_at: *159 + number: *160 + created_at: *161 + updated_at: *162 + url: *163 + html_url: *164 + instances_url: *407 + state: *169 + fixed_at: *165 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *160 - dismissed_reason: *404 - dismissed_comment: *405 - rule: *406 - tool: *407 - most_recent_instance: *408 + dismissed_at: *166 + dismissed_reason: *408 + dismissed_comment: *409 + rule: *410 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: anyOf: - type: 'null' @@ -62232,14 +62274,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &409 + '403': &413 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62259,9 +62301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *311 - - *312 - - &410 + - *316 + - *317 + - &414 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -62269,30 +62311,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *154 + schema: *160 responses: '200': description: Response content: application/json: - schema: &411 + schema: &415 type: object properties: - number: *154 - created_at: *155 - updated_at: *156 - url: *157 - html_url: *158 - instances_url: *403 - state: *163 - fixed_at: *159 + number: *160 + created_at: *161 + updated_at: *162 + url: *163 + html_url: *164 + instances_url: *407 + state: *169 + fixed_at: *165 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *160 - dismissed_reason: *404 - dismissed_comment: *405 + dismissed_at: *166 + dismissed_reason: *408 + dismissed_comment: *409 rule: type: object properties: @@ -62354,8 +62396,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *407 - most_recent_instance: *408 + tool: *411 + most_recent_instance: *412 dismissal_approved_by: anyOf: - type: 'null' @@ -62451,9 +62493,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62471,9 +62513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 requestBody: required: true content: @@ -62488,8 +62530,8 @@ paths: enum: - open - dismissed - dismissed_reason: *404 - dismissed_comment: *405 + dismissed_reason: *408 + dismissed_comment: *409 create_request: type: boolean description: If `true`, attempt to create an alert dismissal request. @@ -62508,7 +62550,7 @@ paths: description: Response content: application/json: - schema: *411 + schema: *415 examples: default: value: @@ -62584,14 +62626,14 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '400': *14 - '403': &415 + '403': &419 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': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -62611,15 +62653,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: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 responses: '200': description: Response content: application/json: - schema: &412 + schema: &416 type: object properties: status: @@ -62646,13 +62688,13 @@ paths: - description - started_at examples: - default: &413 + default: &417 value: status: success description: This fixes an XSS vulnerability by escaping the user input. started_at: '2024-02-14T12:29:18Z' - '400': &414 + '400': &418 description: Bad Request content: application/json: @@ -62663,9 +62705,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': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62688,29 +62730,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: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 responses: '200': description: OK content: application/json: - schema: *412 + schema: *416 examples: - default: *413 + default: *417 '202': description: Accepted content: application/json: - schema: *412 + schema: *416 examples: default: value: status: pending description: started_at: '2024-02-14T12:29:18Z' - '400': *414 + '400': *418 '403': description: Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded @@ -62720,7 +62762,7 @@ paths: '404': *6 '422': description: Unprocessable Entity - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62742,9 +62784,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: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 requestBody: required: false content: @@ -62790,12 +62832,12 @@ paths: value: target_ref: refs/heads/main sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 - '400': *414 - '403': *415 + '400': *418 + '403': *419 '404': *6 '422': description: Unprocessable Entity - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62815,13 +62857,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 - *19 - *17 - - *416 - - *417 + - *420 + - *421 responses: '200': description: Response @@ -62829,7 +62871,7 @@ paths: application/json: schema: type: array - items: *408 + items: *412 examples: default: value: @@ -62868,9 +62910,9 @@ paths: end_column: 50 classifications: - source - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62902,30 +62944,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *311 - - *312 - - *398 - - *399 + - *316 + - *317 + - *402 + - *403 - *19 - *17 - - *417 + - *421 - 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: *400 + schema: *404 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &420 + schema: &424 type: string description: An identifier for the upload. examples: - 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *46 + - *50 - name: sort description: The property by which to sort the results. in: query @@ -62942,23 +62984,23 @@ paths: application/json: schema: type: array - items: &421 + items: &425 type: object properties: - ref: *400 - commit_sha: &429 + ref: *404 + commit_sha: &433 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: *418 + analysis_key: *422 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *419 + category: *423 error: type: string examples: @@ -62983,8 +63025,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *420 - tool: *407 + sarif_id: *424 + tool: *411 deletable: type: boolean warning: @@ -63046,9 +63088,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63082,8 +63124,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: - - *311 - - *312 + - *316 + - *317 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63096,7 +63138,7 @@ paths: description: Response content: application/json: - schema: *421 + schema: *425 examples: response: summary: application/json response @@ -63150,14 +63192,14 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *409 + '403': *413 '404': *6 '422': description: Response if analysis could not be processed content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63237,8 +63279,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: - - *311 - - *312 + - *316 + - *317 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -63294,9 +63336,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': *415 + '403': *419 '404': *6 - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -63316,8 +63358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -63325,7 +63367,7 @@ paths: application/json: schema: type: array - items: &422 + items: &426 title: CodeQL Database description: A CodeQL database. type: object @@ -63437,9 +63479,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': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63466,8 +63508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - name: language in: path description: The language of the CodeQL database. @@ -63479,7 +63521,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *426 examples: default: value: @@ -63511,11 +63553,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': &452 + '302': &456 description: Found - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63535,8 +63577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *311 - - *312 + - *316 + - *317 - name: language in: path description: The language of the CodeQL database. @@ -63546,9 +63588,9 @@ paths: responses: '204': description: Response - '403': *415 + '403': *419 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63574,8 +63616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -63584,7 +63626,7 @@ paths: type: object additionalProperties: false properties: - language: &423 + language: &427 type: string description: The language targeted by the CodeQL query enum: @@ -63664,7 +63706,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &427 + schema: &431 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -63672,9 +63714,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *51 + controller_repo: *55 actor: *4 - query_language: *423 + query_language: *427 query_pack_url: type: string description: The download url for the query pack. @@ -63722,7 +63764,7 @@ paths: items: type: object properties: - repository: &424 + repository: &428 title: Repository Identifier description: Repository Identifier type: object @@ -63764,7 +63806,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &428 + analysis_status: &432 type: string description: The new status of the CodeQL variant analysis repository task. @@ -63796,7 +63838,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &425 + access_mismatch_repos: &429 type: object properties: repository_count: @@ -63811,7 +63853,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: *424 + items: *428 required: - repository_count - repositories @@ -63834,8 +63876,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *425 - over_limit_repos: *425 + no_codeql_db_repos: *429 + over_limit_repos: *429 required: - access_mismatch_repos - not_found_repos @@ -63851,7 +63893,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &426 + value: &430 summary: Default response value: id: 1 @@ -64003,17 +64045,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *426 + value: *430 repository_lists: summary: Response for a successful variant analysis submission - value: *426 + value: *430 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64034,8 +64076,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: - - *311 - - *312 + - *316 + - *317 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -64047,11 +64089,11 @@ paths: description: Response content: application/json: - schema: *427 + schema: *431 examples: - default: *426 + default: *430 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64072,7 +64114,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: - - *311 + - *316 - name: repo in: path description: The name of the controller repository. @@ -64106,8 +64148,8 @@ paths: schema: type: object properties: - repository: *51 - analysis_status: *428 + repository: *55 + analysis_status: *432 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -64211,7 +64253,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64232,8 +64274,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -64326,9 +64368,9 @@ paths: threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *409 + '403': *413 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64347,8 +64389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -64417,7 +64459,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -64442,7 +64484,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *415 + '403': *419 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -64456,7 +64498,7 @@ paths: content: application/json: schema: *3 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64513,8 +64555,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -64522,7 +64564,7 @@ paths: schema: type: object properties: - commit_sha: *429 + commit_sha: *433 ref: type: string description: |- @@ -64582,7 +64624,7 @@ paths: schema: type: object properties: - id: *420 + id: *424 url: type: string description: The REST API URL for checking the status of the upload. @@ -64596,11 +64638,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': *415 + '403': *419 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64619,8 +64661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *311 - - *312 + - *316 + - *317 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -64668,10 +64710,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': *409 + '403': *413 '404': description: Not Found if the sarif id does not match any upload - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -64693,8 +64735,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -64718,7 +64760,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *41 + configuration: *45 examples: default: value: @@ -64750,7 +64792,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': *168 + '204': *174 '304': *35 '403': *27 '404': *6 @@ -64775,8 +64817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *311 - - *312 + - *316 + - *317 - 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 @@ -64904,8 +64946,8 @@ paths: parameters: - *17 - *19 - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -64921,7 +64963,7 @@ paths: type: integer codespaces: type: array - items: *213 + items: *219 examples: default: value: @@ -65197,7 +65239,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': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -65219,8 +65261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -65284,22 +65326,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65323,8 +65365,8 @@ paths: parameters: - *17 - *19 - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -65364,7 +65406,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *96 + '500': *102 '400': *14 '401': *23 '403': *27 @@ -65388,8 +65430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -65426,9 +65468,9 @@ paths: type: integer machines: type: array - items: *431 + items: *435 examples: - default: &645 + default: &647 value: total_count: 2 machines: @@ -65445,7 +65487,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -65468,8 +65510,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *311 - - *312 + - *316 + - *317 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -65556,8 +65598,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: - - *311 - - *312 + - *316 + - *317 - 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 @@ -65605,7 +65647,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65626,8 +65668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -65645,7 +65687,7 @@ paths: type: integer secrets: type: array - items: &435 + items: &439 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -65666,9 +65708,9 @@ paths: - created_at - updated_at examples: - default: *432 + default: *436 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65689,16 +65731,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *433 + schema: *437 examples: - default: *434 + default: *438 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -65718,17 +65760,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '200': description: Response content: application/json: - schema: *435 + schema: *439 examples: - default: *436 + default: *440 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65748,9 +65790,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 requestBody: required: true content: @@ -65778,7 +65820,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -65802,9 +65844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '204': description: Response @@ -65832,8 +65874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *311 - - *312 + - *316 + - *317 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -65871,7 +65913,7 @@ paths: application/json: schema: type: array - items: &437 + items: &441 title: Collaborator description: Collaborator type: object @@ -66039,7 +66081,7 @@ paths: admin: false role_name: write headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -66064,9 +66106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 responses: '204': description: Response if user is a collaborator @@ -66112,9 +66154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 requestBody: required: false content: @@ -66140,7 +66182,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &501 + schema: &505 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -66152,7 +66194,7 @@ paths: format: int64 examples: - 42 - repository: *136 + repository: *142 invitee: anyOf: - type: 'null' @@ -66328,7 +66370,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: *111 '403': *27 x-github: triggersNotification: true @@ -66368,9 +66410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 responses: '204': description: No Content when collaborator was removed from the repository. @@ -66401,9 +66443,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *311 - - *312 - - *57 + - *316 + - *317 + - *61 responses: '200': description: if user has admin permissions @@ -66423,7 +66465,7 @@ paths: user: anyOf: - type: 'null' - - *437 + - *441 required: - permission - role_name @@ -66477,8 +66519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -66488,7 +66530,7 @@ paths: application/json: schema: type: array - items: &438 + items: &442 title: Commit Comment description: Commit Comment type: object @@ -66529,8 +66571,8 @@ paths: updated_at: type: string format: date-time - author_association: *65 - reactions: *66 + author_association: *69 + reactions: *70 required: - url - html_url @@ -66546,7 +66588,7 @@ paths: - created_at - updated_at examples: - default: &441 + default: &445 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66580,7 +66622,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66605,17 +66647,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '200': description: Response content: application/json: - schema: *438 + schema: *442 examples: - default: &442 + default: &446 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -66672,9 +66714,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -66696,7 +66738,7 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: default: value: @@ -66747,9 +66789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '204': description: Response @@ -66770,9 +66812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *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. @@ -66798,11 +66840,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -66821,9 +66863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -66855,16 +66897,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -66886,10 +66928,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *311 - - *312 - - *77 - - *307 + - *316 + - *317 + - *81 + - *314 responses: '204': description: Response @@ -66938,8 +66980,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *311 - - *312 + - *316 + - *317 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -66995,9 +67037,9 @@ paths: application/json: schema: type: array - items: *439 + items: *443 examples: - default: &551 + default: &555 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67067,11 +67109,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *52 - '500': *96 + Link: *56 + '500': *102 '400': *14 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67091,9 +67133,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *311 - - *312 - - &440 + - *316 + - *317 + - &444 name: commit_sha description: The SHA of the commit. in: path @@ -67140,7 +67182,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67165,9 +67207,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 - *17 - *19 responses: @@ -67177,11 +67219,11 @@ paths: application/json: schema: type: array - items: *438 + items: *442 examples: - default: *441 + default: *445 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67207,9 +67249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 requestBody: required: true content: @@ -67244,9 +67286,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *442 examples: - default: *442 + default: *446 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -67274,9 +67316,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 - *17 - *19 responses: @@ -67286,9 +67328,9 @@ paths: application/json: schema: type: array - items: *443 + items: *447 examples: - default: &543 + default: &547 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -67767,8 +67809,8 @@ paths: auto_merge: draft: false headers: - Link: *52 - '409': *45 + Link: *56 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67825,11 +67867,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *311 - - *312 + - *316 + - *317 - *19 - *17 - - &444 + - &448 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)" @@ -67844,9 +67886,9 @@ paths: description: Response content: application/json: - schema: *439 + schema: *443 examples: - default: &529 + default: &533 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -67932,9 +67974,9 @@ paths: ..... '422': *15 '404': *6 - '500': *96 - '503': *97 - '409': *45 + '500': *102 + '503': *103 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67959,11 +68001,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *311 - - *312 - - *444 - - *445 - - *446 + - *316 + - *317 + - *448 + - *449 + - *450 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -67997,11 +68039,11 @@ paths: type: integer check_runs: type: array - items: *391 + items: *395 examples: - default: *447 + default: *451 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68024,9 +68066,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *311 - - *312 - - *444 + - *316 + - *317 + - *448 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -68034,7 +68076,7 @@ paths: schema: type: integer example: 1 - - *445 + - *449 - *17 - *19 responses: @@ -68052,7 +68094,7 @@ paths: type: integer check_suites: type: array - items: *395 + items: *399 examples: default: value: @@ -68227,7 +68269,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: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68252,9 +68294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *311 - - *312 - - *444 + - *316 + - *317 + - *448 - *17 - *19 responses: @@ -68325,7 +68367,7 @@ paths: type: string total_count: type: integer - repository: *136 + repository: *142 commit_url: type: string format: uri @@ -68456,9 +68498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *311 - - *312 - - *444 + - *316 + - *317 + - *448 - *17 - *19 responses: @@ -68468,7 +68510,7 @@ paths: application/json: schema: type: array - items: &616 + items: &620 title: Status description: The status of a commit. type: object @@ -68548,8 +68590,8 @@ paths: type: User site_admin: false headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68577,8 +68619,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -68611,11 +68653,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *448 + - *452 code_of_conduct_file: anyOf: - type: 'null' - - &449 + - &453 title: Community Health File type: object properties: @@ -68631,23 +68673,23 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 contributing: anyOf: - type: 'null' - - *449 + - *453 readme: anyOf: - type: 'null' - - *449 + - *453 issue_template: anyOf: - type: 'null' - - *449 + - *453 pull_request_template: anyOf: - type: 'null' - - *449 + - *453 required: - code_of_conduct - code_of_conduct_file @@ -68776,8 +68818,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *311 - - *312 + - *316 + - *317 - *19 - *17 - name: basehead @@ -68825,8 +68867,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *439 - merge_base_commit: *439 + base_commit: *443 + merge_base_commit: *443 status: type: string enum: @@ -68850,10 +68892,10 @@ paths: - 6 commits: type: array - items: *439 + items: *443 files: type: array - items: *450 + items: *454 required: - url - html_url @@ -69096,8 +69138,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69139,8 +69181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *311 - - *312 + - *316 + - *317 - name: path description: path parameter in: path @@ -69293,7 +69335,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &451 + response-if-content-is-a-file: &455 summary: Response if content is a file value: type: file @@ -69430,7 +69472,7 @@ paths: - size - type - url - - &556 + - &560 title: Content File description: Content File type: object @@ -69648,7 +69690,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *451 + response-if-content-is-a-file: *455 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -69717,7 +69759,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *452 + '302': *456 '304': *35 x-github: githubCloudOnly: false @@ -69740,8 +69782,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *311 - - *312 + - *316 + - *317 - name: path description: path parameter in: path @@ -69836,7 +69878,7 @@ paths: description: Response content: application/json: - schema: &453 + schema: &457 title: File Commit description: File Commit type: object @@ -69992,7 +70034,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *457 examples: example-for-creating-a-file: value: @@ -70046,7 +70088,7 @@ paths: schema: oneOf: - *3 - - &483 + - &487 description: Repository rule violation was detected type: object properties: @@ -70067,7 +70109,7 @@ paths: items: type: object properties: - placeholder_id: &608 + placeholder_id: &612 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -70099,8 +70141,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *311 - - *312 + - *316 + - *317 - name: path description: path parameter in: path @@ -70161,7 +70203,7 @@ paths: description: Response content: application/json: - schema: *453 + schema: *457 examples: default: value: @@ -70195,8 +70237,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *45 - '503': *97 + '409': *49 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70216,8 +70258,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *311 - - *312 + - *316 + - *317 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -70318,7 +70360,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *52 + Link: *56 '204': description: Response if repository is empty '403': *27 @@ -70341,23 +70383,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *311 - - *312 - - *173 - - *174 - - *175 - - *176 + - *316 + - *317 + - *179 + - *180 + - *181 + - *182 - name: manifest in: query description: A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. schema: type: string - - *177 - - *454 - - *178 - - *179 - - *46 + - *183 + - *458 + - *184 + - *185 + - *50 - 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)." @@ -70366,8 +70408,8 @@ paths: schema: type: integer default: 30 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -70375,11 +70417,11 @@ paths: application/json: schema: type: array - items: &457 + items: &461 type: object description: A Dependabot alert. properties: - number: *154 + number: *160 state: type: string description: The state of the Dependabot alert. @@ -70394,7 +70436,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *47 + package: *51 manifest_path: type: string description: The full path to the dependency manifest file, @@ -70425,13 +70467,13 @@ paths: - direct - transitive - - security_advisory: *455 - security_vulnerability: *50 - url: *157 - html_url: *158 - created_at: *155 - updated_at: *156 - dismissed_at: *160 + security_advisory: *459 + security_vulnerability: *54 + url: *163 + html_url: *164 + created_at: *161 + updated_at: *162 + dismissed_at: *166 dismissed_by: anyOf: - type: 'null' @@ -70455,8 +70497,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *159 - auto_dismissed_at: *456 + fixed_at: *165 + auto_dismissed_at: *460 required: - number - state @@ -70686,9 +70728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *311 - - *312 - - &458 + - *316 + - *317 + - &462 name: alert_number in: path description: |- @@ -70697,13 +70739,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *154 + schema: *160 responses: '200': description: Response content: application/json: - schema: *457 + schema: *461 examples: default: value: @@ -70816,9 +70858,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *311 - - *312 - - *458 + - *316 + - *317 + - *462 requestBody: required: true content: @@ -70863,7 +70905,7 @@ paths: description: Response content: application/json: - schema: *457 + schema: *461 examples: default: value: @@ -70969,7 +71011,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *45 + '409': *49 '422': *7 x-github: githubCloudOnly: false @@ -70992,8 +71034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -71011,7 +71053,7 @@ paths: type: integer secrets: type: array - items: &461 + items: &465 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -71043,7 +71085,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71065,16 +71107,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *459 + schema: *463 examples: - default: *460 + default: *464 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71094,15 +71136,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '200': description: Response content: application/json: - schema: *461 + schema: *465 examples: default: value: @@ -71128,9 +71170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 requestBody: required: true content: @@ -71158,7 +71200,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -71182,9 +71224,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *311 - - *312 - - *144 + - *316 + - *317 + - *150 responses: '204': description: Response @@ -71206,8 +71248,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: - - *311 - - *312 + - *316 + - *317 - 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 @@ -71357,7 +71399,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *52 + Link: *56 '404': *6 '403': description: Response for a private repository when GitHub Advanced Security @@ -71381,8 +71423,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -71619,7 +71661,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *52 + Link: *56 '404': *6 '403': *27 x-github: @@ -71642,8 +71684,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -71726,7 +71768,7 @@ paths: - version - url additionalProperties: false - metadata: &462 + metadata: &466 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -71765,7 +71807,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *462 + metadata: *466 resolved: type: object description: A collection of resolved package dependencies. @@ -71779,7 +71821,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *462 + metadata: *466 relationship: type: string description: A notation of whether a dependency is requested @@ -71912,8 +71954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *311 - - *312 + - *316 + - *317 - name: sha description: The SHA recorded at creation time. in: query @@ -71954,11 +71996,11 @@ paths: application/json: schema: type: array - items: *463 + items: *467 examples: - default: *464 + default: *468 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72022,8 +72064,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -72105,7 +72147,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: simple-example: summary: Simple example @@ -72178,9 +72220,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *311 - - *312 - - &465 + - *316 + - *317 + - &469 name: deployment_id description: deployment_id parameter in: path @@ -72192,7 +72234,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *467 examples: default: value: @@ -72257,9 +72299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 responses: '204': description: Response @@ -72281,9 +72323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 - *17 - *19 responses: @@ -72293,7 +72335,7 @@ paths: application/json: schema: type: array - items: &466 + items: &470 title: Deployment Status description: The status of a deployment. type: object @@ -72437,7 +72479,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -72457,9 +72499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 requestBody: required: true content: @@ -72534,9 +72576,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: &467 + default: &471 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -72592,9 +72634,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *311 - - *312 - - *465 + - *316 + - *317 + - *469 - name: status_id in: path required: true @@ -72605,9 +72647,9 @@ paths: description: Response content: application/json: - schema: *466 + schema: *470 examples: - default: *467 + default: *471 '404': *6 x-github: githubCloudOnly: false @@ -72632,8 +72674,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -72690,8 +72732,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -72709,7 +72751,7 @@ paths: - 5 environments: type: array - items: &469 + items: &473 title: Environment description: Details of a deployment environment type: object @@ -72771,7 +72813,7 @@ paths: type: string examples: - wait_timer - wait_timer: &471 + wait_timer: &475 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -72813,11 +72855,11 @@ paths: items: type: object properties: - type: *468 + type: *472 reviewer: anyOf: - *4 - - *172 + - *178 required: - id - node_id @@ -72840,7 +72882,7 @@ paths: - id - node_id - type - deployment_branch_policy: &472 + deployment_branch_policy: &476 type: - object - 'null' @@ -72957,9 +72999,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *311 - - *312 - - &470 + - *316 + - *317 + - &474 name: environment_name in: path required: true @@ -72972,9 +73014,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *473 examples: - default: &473 + default: &477 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -73058,9 +73100,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 requestBody: required: false content: @@ -73070,7 +73112,7 @@ paths: - object - 'null' properties: - wait_timer: *471 + wait_timer: *475 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -73089,14 +73131,14 @@ paths: items: type: object properties: - type: *468 + type: *472 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *472 + deployment_branch_policy: *476 additionalProperties: false examples: default: @@ -73116,9 +73158,9 @@ paths: description: Response content: application/json: - schema: *469 + schema: *473 examples: - default: *473 + default: *477 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -73142,9 +73184,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 responses: '204': description: Default response @@ -73169,9 +73211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 - *17 - *19 responses: @@ -73190,7 +73232,7 @@ paths: - 2 branch_policies: type: array - items: &474 + items: &478 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -73251,9 +73293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 requestBody: required: true content: @@ -73301,9 +73343,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: - example-wildcard: &475 + example-wildcard: &479 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -73345,10 +73387,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 - - &476 + - *316 + - *317 + - *474 + - &480 name: branch_policy_id in: path required: true @@ -73360,9 +73402,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: - default: *475 + default: *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73381,10 +73423,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 - - *476 + - *316 + - *317 + - *474 + - *480 requestBody: required: true content: @@ -73413,9 +73455,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *478 examples: - default: *475 + default: *479 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73434,10 +73476,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *311 - - *312 - - *470 - - *476 + - *316 + - *317 + - *474 + - *480 responses: '204': description: Response @@ -73462,9 +73504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *470 - - *312 - - *311 + - *474 + - *317 + - *316 responses: '200': description: List of deployment protection rules @@ -73481,7 +73523,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &477 + items: &481 title: Deployment protection rule description: Deployment protection rule type: object @@ -73503,7 +73545,7 @@ paths: for the environment. examples: - true - app: &478 + app: &482 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -73606,9 +73648,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: - - *470 - - *312 - - *311 + - *474 + - *317 + - *316 requestBody: content: application/json: @@ -73629,9 +73671,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *477 + schema: *481 examples: - default: &479 + default: &483 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -73666,9 +73708,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: - - *470 - - *312 - - *311 + - *474 + - *317 + - *316 - *19 - *17 responses: @@ -73688,7 +73730,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *478 + items: *482 examples: default: value: @@ -73723,10 +73765,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *311 - - *312 - - *470 - - &480 + - *316 + - *317 + - *474 + - &484 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -73738,9 +73780,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *481 examples: - default: *479 + default: *483 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73761,10 +73803,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *470 - - *312 - - *311 - - *480 + - *474 + - *317 + - *316 + - *484 responses: '204': description: Response @@ -73790,9 +73832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 - *17 - *19 responses: @@ -73810,11 +73852,11 @@ paths: type: integer secrets: type: array - items: *357 + items: *361 examples: - default: *358 + default: *362 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73837,17 +73879,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 responses: '200': description: Response content: application/json: - schema: *359 + schema: *363 examples: - default: *360 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73869,18 +73911,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *311 - - *312 - - *470 - - *144 + - *316 + - *317 + - *474 + - *150 responses: '200': description: Response content: application/json: - schema: *357 + schema: *361 examples: - default: *481 + default: *485 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73902,10 +73944,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *311 - - *312 - - *470 - - *144 + - *316 + - *317 + - *474 + - *150 requestBody: required: true content: @@ -73936,7 +73978,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -73962,10 +74004,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *311 - - *312 - - *470 - - *144 + - *316 + - *317 + - *474 + - *150 responses: '204': description: Default response @@ -73990,10 +74032,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *311 - - *312 - - *470 - - *328 + - *316 + - *317 + - *474 + - *332 - *19 responses: '200': @@ -74010,11 +74052,11 @@ paths: type: integer variables: type: array - items: *361 + items: *365 examples: - default: *362 + default: *366 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74035,9 +74077,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *311 - - *312 - - *470 + - *316 + - *317 + - *474 requestBody: required: true content: @@ -74064,7 +74106,7 @@ paths: description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -74089,18 +74131,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *311 - - *312 - - *470 - - *147 + - *316 + - *317 + - *474 + - *153 responses: '200': description: Response content: application/json: - schema: *361 + schema: *365 examples: - default: *482 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74121,10 +74163,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *311 - - *312 - - *147 - - *470 + - *316 + - *317 + - *153 + - *474 requestBody: required: true content: @@ -74166,10 +74208,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *311 - - *312 - - *147 - - *470 + - *316 + - *317 + - *153 + - *474 responses: '204': description: Response @@ -74191,8 +74233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -74202,7 +74244,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: 200-response: value: @@ -74260,8 +74302,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *311 - - *312 + - *316 + - *317 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -74283,7 +74325,7 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: default: value: @@ -74396,7 +74438,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *52 + Link: *56 '400': *14 x-github: githubCloudOnly: false @@ -74420,8 +74462,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -74454,9 +74496,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 '400': *14 '422': *15 '403': *27 @@ -74477,8 +74519,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -74529,7 +74571,7 @@ paths: schema: type: string '404': *6 - '409': *45 + '409': *49 '403': *27 '422': description: Validation failed @@ -74537,8 +74579,8 @@ paths: application/json: schema: oneOf: - - *105 - - *483 + - *111 + - *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74563,8 +74605,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *311 - - *312 + - *316 + - *317 - name: file_sha in: path required: true @@ -74616,7 +74658,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74664,8 +74706,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -74774,7 +74816,7 @@ paths: description: Response content: application/json: - schema: &484 + schema: &488 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -74951,7 +74993,7 @@ paths: type: string '422': *15 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75001,15 +75043,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *311 - - *312 - - *440 + - *316 + - *317 + - *444 responses: '200': description: Response content: application/json: - schema: *484 + schema: *488 examples: default: value: @@ -75040,7 +75082,7 @@ paths: payload: verified_at: '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75065,9 +75107,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *311 - - *312 - - &485 + - *316 + - *317 + - &489 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. @@ -75084,7 +75126,7 @@ paths: application/json: schema: type: array - items: &486 + items: &490 title: Git Reference description: Git references within a repository type: object @@ -75138,8 +75180,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *52 - '409': *45 + Link: *56 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75160,17 +75202,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *311 - - *312 - - *485 + - *316 + - *317 + - *489 responses: '200': description: Response content: application/json: - schema: *486 + schema: *490 examples: - default: &487 + default: &491 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -75180,7 +75222,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75199,8 +75241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -75229,16 +75271,16 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: - default: *487 + default: *491 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75257,9 +75299,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *311 - - *312 - - *485 + - *316 + - *317 + - *489 requestBody: required: true content: @@ -75288,11 +75330,11 @@ paths: description: Response content: application/json: - schema: *486 + schema: *490 examples: - default: *487 + default: *491 '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75308,16 +75350,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *311 - - *312 - - *485 + - *316 + - *317 + - *489 responses: '204': description: Response '422': description: Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75365,8 +75407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -75433,7 +75475,7 @@ paths: description: Response content: application/json: - schema: &489 + schema: &493 title: Git Tag description: Metadata for a Git tag type: object @@ -75489,7 +75531,7 @@ paths: - sha - type - url - verification: *488 + verification: *492 required: - sha - url @@ -75499,7 +75541,7 @@ paths: - tag - message examples: - default: &490 + default: &494 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -75526,7 +75568,7 @@ paths: schema: type: string '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75572,8 +75614,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *311 - - *312 + - *316 + - *317 - name: tag_sha in: path required: true @@ -75584,11 +75626,11 @@ paths: description: Response content: application/json: - schema: *489 + schema: *493 examples: - default: *490 + default: *494 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75610,8 +75652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -75685,7 +75727,7 @@ paths: description: Response content: application/json: - schema: &491 + schema: &495 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -75764,7 +75806,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75787,8 +75829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *311 - - *312 + - *316 + - *317 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -75811,7 +75853,7 @@ paths: description: Response content: application/json: - schema: *491 + schema: *495 examples: default-response: summary: Default response @@ -75852,7 +75894,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75870,8 +75912,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -75881,7 +75923,7 @@ paths: application/json: schema: type: array - items: &492 + items: &496 title: Webhook description: Webhooks for repositories. type: object @@ -75944,7 +75986,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &720 + last_response: &731 title: Hook Response type: object properties: @@ -76002,7 +76044,7 @@ paths: status: unused message: headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -76021,8 +76063,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -76075,9 +76117,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: &493 + default: &497 value: type: Repository id: 12345678 @@ -76125,17 +76167,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '200': description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *493 + default: *497 '404': *6 x-github: githubCloudOnly: false @@ -76155,9 +76197,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 requestBody: required: true content: @@ -76202,9 +76244,9 @@ paths: description: Response content: application/json: - schema: *492 + schema: *496 examples: - default: *493 + default: *497 '422': *15 '404': *6 x-github: @@ -76225,9 +76267,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '204': description: Response @@ -76251,9 +76293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '200': description: Response @@ -76280,9 +76322,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 requestBody: required: false content: @@ -76326,11 +76368,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 - *17 - - *186 + - *192 responses: '200': description: Response @@ -76338,9 +76380,9 @@ paths: application/json: schema: type: array - items: *187 + items: *193 examples: - default: *188 + default: *194 '400': *14 '422': *15 x-github: @@ -76359,18 +76401,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 - *16 responses: '200': description: Response content: application/json: - schema: *189 + schema: *195 examples: - default: *190 + default: *196 '400': *14 '422': *15 x-github: @@ -76389,9 +76431,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 - *16 responses: '202': *37 @@ -76414,9 +76456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '204': description: Response @@ -76441,9 +76483,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *311 - - *312 - - *185 + - *316 + - *317 + - *191 responses: '204': description: Response @@ -76466,8 +76508,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response if immutable releases are enabled @@ -76515,11 +76557,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-immutable-releases parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 - '409': *45 + '204': *174 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76536,11 +76578,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-immutable-releases parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 - '409': *45 + '204': *174 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76594,14 +76636,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: &494 + schema: &498 title: Import description: A repository import from an external source. type: object @@ -76708,7 +76750,7 @@ paths: - html_url - authors_url examples: - default: &497 + default: &501 value: vcs: subversion use_lfs: true @@ -76724,7 +76766,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': &495 + '503': &499 description: Unavailable due to service under maintenance. content: application/json: @@ -76753,8 +76795,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -76802,7 +76844,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *498 examples: default: value: @@ -76827,7 +76869,7 @@ paths: type: string '422': *15 '404': *6 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76855,8 +76897,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -76908,7 +76950,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *498 examples: example-1: summary: Example 1 @@ -76956,7 +76998,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': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76979,12 +77021,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77010,9 +77052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *311 - - *312 - - &666 + - *316 + - *317 + - &668 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77026,7 +77068,7 @@ paths: application/json: schema: type: array - items: &496 + items: &500 title: Porter Author description: Porter Author type: object @@ -77080,7 +77122,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': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77105,8 +77147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *311 - - *312 + - *316 + - *317 - name: author_id in: path required: true @@ -77136,7 +77178,7 @@ paths: description: Response content: application/json: - schema: *496 + schema: *500 examples: default: value: @@ -77149,7 +77191,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77173,8 +77215,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -77215,7 +77257,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77243,8 +77285,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -77271,11 +77313,11 @@ paths: description: Response content: application/json: - schema: *494 + schema: *498 examples: - default: *497 + default: *501 '422': *15 - '503': *495 + '503': *499 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77298,8 +77340,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -77307,8 +77349,8 @@ paths: application/json: schema: *20 examples: - default: *498 - '301': *318 + default: *502 + '301': *320 '404': *6 x-github: githubCloudOnly: false @@ -77328,8 +77370,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -77337,12 +77379,12 @@ paths: application/json: schema: anyOf: - - *203 + - *209 - type: object properties: {} additionalProperties: false examples: - default: &500 + default: &504 value: limit: collaborators_only origin: repository @@ -77367,13 +77409,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: application/json: - schema: *499 + schema: *503 examples: default: summary: Example request body @@ -77385,9 +77427,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *209 examples: - default: *500 + default: *504 '409': description: Response x-github: @@ -77409,8 +77451,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -77433,8 +77475,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -77444,9 +77486,9 @@ paths: application/json: schema: type: array - items: *501 + items: *505 examples: - default: &659 + default: &661 value: - id: 1 repository: @@ -77560,7 +77602,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77577,9 +77619,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *311 - - *312 - - *207 + - *316 + - *317 + - *213 requestBody: required: false content: @@ -77608,7 +77650,7 @@ paths: description: Response content: application/json: - schema: *501 + schema: *505 examples: default: value: @@ -77739,9 +77781,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *311 - - *312 - - *207 + - *316 + - *317 + - *213 responses: '204': description: Response @@ -77772,8 +77814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *311 - - *312 + - *316 + - *317 - 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 @@ -77821,7 +77863,7 @@ paths: required: false schema: type: string - - *211 + - *217 - name: sort description: What to sort results by. in: query @@ -77833,8 +77875,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - *17 - *19 responses: @@ -77844,9 +77886,9 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: &509 + default: &513 value: - id: 1 node_id: MDU6SXNzdWUx @@ -77993,8 +78035,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '422': *15 '404': *6 x-github: @@ -78023,8 +78065,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -78114,9 +78156,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: &506 + default: &510 value: id: 1 node_id: MDU6SXNzdWUx @@ -78270,9 +78312,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *97 + '503': *103 '404': *6 - '410': *502 + '410': *506 x-github: triggersNotification: true githubCloudOnly: false @@ -78300,9 +78342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *311 - - *312 - - *87 + - *316 + - *317 + - *91 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -78312,7 +78354,7 @@ paths: enum: - asc - desc - - *68 + - *72 - *17 - *19 responses: @@ -78322,9 +78364,9 @@ paths: application/json: schema: type: array - items: *503 + items: *507 examples: - default: &508 + default: &512 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78355,7 +78397,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *52 + Link: *56 '422': *15 '404': *6 x-github: @@ -78382,17 +78424,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '200': description: Response content: application/json: - schema: *503 + schema: *507 examples: - default: &504 + default: &508 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -78446,9 +78488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -78470,9 +78512,9 @@ paths: description: Response content: application/json: - schema: *503 + schema: *507 examples: - default: *504 + default: *508 '422': *15 x-github: githubCloudOnly: false @@ -78490,9 +78532,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '204': description: Response @@ -78512,9 +78554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *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. @@ -78540,11 +78582,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -78563,9 +78605,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -78597,16 +78639,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -78628,10 +78670,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *311 - - *312 - - *77 - - *307 + - *316 + - *317 + - *81 + - *314 responses: '204': description: Response @@ -78651,8 +78693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -78662,7 +78704,7 @@ paths: application/json: schema: type: array - items: &505 + items: &509 title: Issue Event description: Issue Event type: object @@ -78709,7 +78751,7 @@ paths: issue: anyOf: - type: 'null' - - *78 + - *82 label: title: Issue Event Label description: Issue Event Label @@ -78742,7 +78784,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *172 + requested_team: *178 dismissed_review: title: Issue Event Dismissed Review type: object @@ -78809,7 +78851,7 @@ paths: required: - from - to - author_association: *65 + author_association: *69 lock_reason: type: - string @@ -78983,7 +79025,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -79001,8 +79043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *311 - - *312 + - *316 + - *317 - name: event_id in: path required: true @@ -79013,7 +79055,7 @@ paths: description: Response content: application/json: - schema: *505 + schema: *509 examples: default: value: @@ -79190,7 +79232,6 @@ paths: metadata: read contents: read issues: write - single_file: write events: - push - pull_request @@ -79206,7 +79247,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *502 + '410': *506 '403': *27 x-github: githubCloudOnly: false @@ -79240,9 +79281,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *311 - - *312 - - &507 + - *316 + - *317 + - &511 name: issue_number description: The number that identifies the issue. in: path @@ -79254,12 +79295,12 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 - '301': *318 + default: *510 + '301': *320 '404': *6 - '410': *502 + '410': *506 '304': *35 x-github: githubCloudOnly: false @@ -79284,9 +79325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -79405,15 +79446,15 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 '422': *15 - '503': *97 + '503': *103 '403': *27 - '301': *318 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79431,9 +79472,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -79459,9 +79500,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79477,9 +79518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: content: application/json: @@ -79504,9 +79545,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79528,9 +79569,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: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - name: assignee in: path required: true @@ -79570,10 +79611,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *311 - - *312 - - *507 - - *68 + - *316 + - *317 + - *511 + - *72 - *17 - *19 responses: @@ -79583,13 +79624,13 @@ paths: application/json: schema: type: array - items: *503 + items: *507 examples: - default: *508 + default: *512 headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79618,9 +79659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -79642,16 +79683,16 @@ paths: description: Response content: application/json: - schema: *503 + schema: *507 examples: - default: *504 + default: *508 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *502 + '410': *506 '422': *15 '404': *6 x-github: @@ -79679,9 +79720,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -79691,14 +79732,14 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *509 + default: *513 headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79726,9 +79767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -79750,17 +79791,17 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by schema: type: string - '301': *318 + '301': *320 '403': *27 - '410': *502 + '410': *506 '422': *15 '404': *6 x-github: @@ -79791,9 +79832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - name: issue_id in: path description: The id of the blocking issue to remove as a dependency @@ -79805,15 +79846,15 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 - '301': *318 + default: *510 + '301': *320 '400': *14 '401': *23 '403': *27 '404': *6 - '410': *502 + '410': *506 x-github: triggersNotification: true githubCloudOnly: false @@ -79839,9 +79880,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -79851,14 +79892,14 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *509 + default: *513 headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79875,9 +79916,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -79891,7 +79932,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &512 + - &516 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -79940,7 +79981,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &513 + - &517 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -80068,7 +80109,7 @@ paths: - performed_via_github_app - assignee - assigner - - &514 + - &518 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -80114,7 +80155,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &515 + - &519 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -80160,7 +80201,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &516 + - &520 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -80209,7 +80250,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &517 + - &521 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -80238,7 +80279,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *172 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -80251,7 +80292,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &518 + - &522 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -80280,7 +80321,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *172 + requested_team: *178 requested_reviewer: *4 required: - review_requester @@ -80293,7 +80334,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &519 + - &523 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -80349,7 +80390,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &520 + - &524 title: Locked Issue Event description: Locked Issue Event type: object @@ -80394,7 +80435,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &521 + - &525 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -80455,7 +80496,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &522 + - &526 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -80516,7 +80557,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &523 + - &527 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -80577,7 +80618,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &524 + - &528 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -80669,8 +80710,8 @@ paths: name: label color: red headers: - Link: *52 - '410': *502 + Link: *56 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80687,9 +80728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -80699,7 +80740,7 @@ paths: application/json: schema: type: array - items: &510 + items: &514 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -80754,7 +80795,7 @@ paths: - color - default examples: - default: &511 + default: &515 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -80771,10 +80812,10 @@ paths: color: a2eeef default: false headers: - Link: *52 - '301': *318 + Link: *56 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80791,9 +80832,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -80852,12 +80893,12 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 - '301': *318 + default: *515 + '301': *320 '404': *6 - '410': *502 + '410': *506 '422': *15 x-github: githubCloudOnly: false @@ -80874,9 +80915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -80936,12 +80977,12 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 - '301': *318 + default: *515 + '301': *320 '404': *6 - '410': *502 + '410': *506 '422': *15 x-github: githubCloudOnly: false @@ -80958,15 +80999,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 responses: '204': description: Response - '301': *318 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80985,9 +81026,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - name: name in: path required: true @@ -81000,7 +81041,7 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: default: value: @@ -81011,9 +81052,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *318 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81033,9 +81074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: false content: @@ -81064,7 +81105,7 @@ paths: '204': description: Response '403': *27 - '410': *502 + '410': *506 '404': *6 '422': *15 x-github: @@ -81082,9 +81123,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 responses: '204': description: Response @@ -81114,20 +81155,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 responses: '200': description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 - '301': *318 + default: *510 + '301': *320 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81144,9 +81185,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - 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. @@ -81172,13 +81213,13 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81196,9 +81237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81230,16 +81271,16 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -81261,10 +81302,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *311 - - *312 - - *507 - - *307 + - *316 + - *317 + - *511 + - *314 responses: '204': description: Response @@ -81293,9 +81334,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81317,9 +81358,9 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -81352,9 +81393,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -81364,13 +81405,13 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *509 + default: *513 headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81398,9 +81439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81427,16 +81468,16 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *502 + '410': *506 '422': *15 '404': *6 x-github: @@ -81456,9 +81497,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 requestBody: required: true content: @@ -81489,13 +81530,13 @@ paths: description: Response content: application/json: - schema: *78 + schema: *82 examples: - default: *506 + default: *510 '403': *27 '404': *6 '422': *7 - '503': *97 + '503': *103 x-github: triggersNotification: true githubCloudOnly: false @@ -81513,9 +81554,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *311 - - *312 - - *507 + - *316 + - *317 + - *511 - *17 - *19 responses: @@ -81530,10 +81571,6 @@ paths: description: Timeline Event type: object anyOf: - - *512 - - *513 - - *514 - - *515 - *516 - *517 - *518 @@ -81543,6 +81580,10 @@ paths: - *522 - *523 - *524 + - *525 + - *526 + - *527 + - *528 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -81590,12 +81631,12 @@ paths: issue_url: type: string format: uri - author_association: *65 + author_association: *69 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *66 + reactions: *70 required: - event - actor @@ -81626,7 +81667,7 @@ paths: properties: type: type: string - issue: *78 + issue: *82 required: - event - created_at @@ -81848,7 +81889,7 @@ paths: type: string body_text: type: string - author_association: *65 + author_association: *69 required: - event - id @@ -81871,7 +81912,7 @@ paths: type: string comments: type: array - items: &545 + items: &549 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -81976,7 +82017,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *65 + author_association: *69 _links: type: object properties: @@ -82071,7 +82112,7 @@ paths: enum: - line - file - reactions: *66 + reactions: *70 body_html: type: string examples: @@ -82109,7 +82150,7 @@ paths: type: string comments: type: array - items: *438 + items: *442 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -82382,9 +82423,9 @@ paths: type: User site_admin: true headers: - Link: *52 + Link: *56 '404': *6 - '410': *502 + '410': *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82401,8 +82442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -82412,7 +82453,7 @@ paths: application/json: schema: type: array - items: &525 + items: &529 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -82464,7 +82505,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82480,8 +82521,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -82517,9 +82558,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *529 examples: - default: &526 + default: &530 value: id: 1 key: ssh-rsa AAA... @@ -82553,9 +82594,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *311 - - *312 - - &527 + - *316 + - *317 + - &531 name: key_id description: The unique identifier of the key. in: path @@ -82567,9 +82608,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *529 examples: - default: *526 + default: *530 '404': *6 x-github: githubCloudOnly: false @@ -82587,9 +82628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *311 - - *312 - - *527 + - *316 + - *317 + - *531 responses: '204': description: Response @@ -82609,8 +82650,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -82620,11 +82661,11 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 + default: *515 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -82643,8 +82684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -82680,9 +82721,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: - default: &528 + default: &532 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -82714,8 +82755,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *311 - - *312 + - *316 + - *317 - name: name in: path required: true @@ -82726,9 +82767,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: - default: *528 + default: *532 '404': *6 x-github: githubCloudOnly: false @@ -82745,8 +82786,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *311 - - *312 + - *316 + - *317 - name: name in: path required: true @@ -82785,7 +82826,7 @@ paths: description: Response content: application/json: - schema: *510 + schema: *514 examples: default: value: @@ -82811,8 +82852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *311 - - *312 + - *316 + - *317 - name: name in: path required: true @@ -82838,8 +82879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -82878,9 +82919,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *311 - - *312 - - *416 + - *316 + - *317 + - *420 responses: '200': description: Response @@ -82946,7 +82987,7 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 required: - _links - git_url @@ -83027,8 +83068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83093,8 +83134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83128,9 +83169,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *439 + schema: *443 examples: - default: *529 + default: *533 '204': description: Response when already merged '404': @@ -83155,8 +83196,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *311 - - *312 + - *316 + - *317 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -83197,7 +83238,7 @@ paths: application/json: schema: type: array - items: *244 + items: *250 examples: default: value: @@ -83236,7 +83277,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -83253,8 +83294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83294,9 +83335,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: &530 + default: &534 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -83355,9 +83396,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *311 - - *312 - - &531 + - *316 + - *317 + - &535 name: milestone_number description: The number that identifies the milestone. in: path @@ -83369,9 +83410,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *530 + default: *534 '404': *6 x-github: githubCloudOnly: false @@ -83388,9 +83429,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *311 - - *312 - - *531 + - *316 + - *317 + - *535 requestBody: required: false content: @@ -83428,9 +83469,9 @@ paths: description: Response content: application/json: - schema: *244 + schema: *250 examples: - default: *530 + default: *534 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83446,9 +83487,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *311 - - *312 - - *531 + - *316 + - *317 + - *535 responses: '204': description: Response @@ -83469,9 +83510,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *311 - - *312 - - *531 + - *316 + - *317 + - *535 - *17 - *19 responses: @@ -83481,11 +83522,11 @@ paths: application/json: schema: type: array - items: *510 + items: *514 examples: - default: *511 + default: *515 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83502,12 +83543,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *311 - - *312 - - *532 - - *533 - - *68 - - *534 + - *316 + - *317 + - *536 + - *537 + - *72 + - *538 - *17 - *19 responses: @@ -83517,11 +83558,11 @@ paths: application/json: schema: type: array - items: *90 + items: *94 examples: - default: *535 + default: *539 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -83543,8 +83584,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -83602,14 +83643,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: &536 + schema: &540 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -83753,7 +83794,7 @@ paths: - custom_404 - public examples: - default: &537 + default: &541 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -83794,8 +83835,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83850,11 +83891,11 @@ paths: description: Response content: application/json: - schema: *536 + schema: *540 examples: - default: *537 + default: *541 '422': *15 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83875,8 +83916,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -83955,7 +83996,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83976,14 +84017,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response '422': *15 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84003,8 +84044,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -84014,7 +84055,7 @@ paths: application/json: schema: type: array - items: &538 + items: &542 title: Page Build description: Page Build type: object @@ -84087,7 +84128,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84106,8 +84147,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *311 - - *312 + - *316 + - *317 responses: '201': description: Response @@ -84154,16 +84195,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *538 + schema: *542 examples: - default: &539 + default: &543 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -84211,8 +84252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *311 - - *312 + - *316 + - *317 - name: build_id in: path required: true @@ -84223,9 +84264,9 @@ paths: description: Response content: application/json: - schema: *538 + schema: *542 examples: - default: *539 + default: *543 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84245,8 +84286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -84354,9 +84395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *311 - - *312 - - &540 + - *316 + - *317 + - &544 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -84414,11 +84455,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *311 - - *312 - - *540 + - *316 + - *317 + - *544 responses: - '204': *168 + '204': *174 '404': *6 x-github: githubCloudOnly: false @@ -84443,8 +84484,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -84712,7 +84753,7 @@ paths: description: Empty response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -84739,8 +84780,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: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Private vulnerability reporting status @@ -84777,10 +84818,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 + '204': *174 '422': *14 x-github: githubCloudOnly: false @@ -84799,10 +84840,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: - '204': *168 + '204': *174 '422': *14 x-github: githubCloudOnly: false @@ -84822,8 +84863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -84831,9 +84872,9 @@ paths: application/json: schema: type: array - items: *95 + items: *101 examples: - default: *541 + default: *545 '403': *27 '404': *6 x-github: @@ -84855,8 +84896,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -84868,11 +84909,11 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *95 + items: *101 required: - properties examples: - default: *542 + default: *546 responses: '204': description: No Content when custom property values are successfully created @@ -84910,8 +84951,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *311 - - *312 + - *316 + - *317 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -84971,11 +85012,11 @@ paths: application/json: schema: type: array - items: *443 + items: *447 examples: - default: *543 + default: *547 headers: - Link: *52 + Link: *56 '304': *35 '422': *15 x-github: @@ -85005,8 +85046,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -85073,7 +85114,7 @@ paths: description: Response content: application/json: - schema: &547 + schema: &551 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -85202,7 +85243,7 @@ paths: milestone: anyOf: - type: 'null' - - *244 + - *250 active_lock_reason: type: - string @@ -85257,7 +85298,7 @@ paths: type: - array - 'null' - items: *223 + items: *229 head: type: object properties: @@ -85265,7 +85306,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: *4 @@ -85282,7 +85323,7 @@ paths: type: string ref: type: string - repo: *64 + repo: *68 sha: type: string user: *4 @@ -85295,14 +85336,14 @@ paths: _links: type: object properties: - comments: *245 - commits: *245 - statuses: *245 - html: *245 - issue: *245 - review_comments: *245 - review_comment: *245 - self: *245 + comments: *251 + commits: *251 + statuses: *251 + html: *251 + issue: *251 + review_comments: *251 + review_comment: *251 + self: *251 required: - comments - commits @@ -85312,8 +85353,8 @@ paths: - review_comments - review_comment - self - author_association: *65 - auto_merge: *544 + author_association: *69 + auto_merge: *548 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -85415,7 +85456,7 @@ paths: - merged_by - review_comments examples: - default: &548 + default: &552 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -85942,8 +85983,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *311 - - *312 + - *316 + - *317 - name: sort in: query required: false @@ -85962,7 +86003,7 @@ paths: enum: - asc - desc - - *68 + - *72 - *17 - *19 responses: @@ -85972,9 +86013,9 @@ paths: application/json: schema: type: array - items: *545 + items: *549 examples: - default: &550 + default: &554 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86026,7 +86067,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86051,17 +86092,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '200': description: Response content: application/json: - schema: *545 + schema: *549 examples: - default: &546 + default: &550 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -86136,9 +86177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -86160,9 +86201,9 @@ paths: description: Response content: application/json: - schema: *545 + schema: *549 examples: - default: *546 + default: *550 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86178,9 +86219,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 responses: '204': description: Response @@ -86201,9 +86242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *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. @@ -86229,11 +86270,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -86252,9 +86293,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *311 - - *312 - - *77 + - *316 + - *317 + - *81 requestBody: required: true content: @@ -86286,16 +86327,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -86317,10 +86358,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *311 - - *312 - - *77 - - *307 + - *316 + - *317 + - *81 + - *314 responses: '204': description: Response @@ -86363,9 +86404,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *311 - - *312 - - &549 + - *316 + - *317 + - &553 name: pull_number description: The number that identifies the pull request. in: path @@ -86378,9 +86419,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *547 + schema: *551 examples: - default: *548 + default: *552 '304': *35 '404': *6 '406': @@ -86388,8 +86429,8 @@ paths: content: application/json: schema: *3 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86415,9 +86456,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -86459,9 +86500,9 @@ paths: description: Response content: application/json: - schema: *547 + schema: *551 examples: - default: *548 + default: *552 '422': *15 '403': *27 x-github: @@ -86483,9 +86524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: true content: @@ -86546,21 +86587,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '401': *23 '403': *27 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86586,10 +86627,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *311 - - *312 - - *549 - - *87 + - *316 + - *317 + - *553 + - *91 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -86599,7 +86640,7 @@ paths: enum: - asc - desc - - *68 + - *72 - *17 - *19 responses: @@ -86609,11 +86650,11 @@ paths: application/json: schema: type: array - items: *545 + items: *549 examples: - default: *550 + default: *554 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86644,9 +86685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: true content: @@ -86752,7 +86793,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *549 examples: example-for-a-multi-line-comment: value: @@ -86840,10 +86881,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *311 - - *312 - - *549 - - *77 + - *316 + - *317 + - *553 + - *81 requestBody: required: true content: @@ -86865,7 +86906,7 @@ paths: description: Response content: application/json: - schema: *545 + schema: *549 examples: default: value: @@ -86951,9 +86992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 - *17 - *19 responses: @@ -86963,11 +87004,11 @@ paths: application/json: schema: type: array - items: *439 + items: *443 examples: - default: *551 + default: *555 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86995,9 +87036,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 - *17 - *19 responses: @@ -87007,7 +87048,7 @@ paths: application/json: schema: type: array - items: *450 + items: *454 examples: default: value: @@ -87023,10 +87064,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *52 + Link: *56 '422': *15 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87045,9 +87086,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 responses: '204': description: Response if pull request has been merged @@ -87070,9 +87111,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -87184,9 +87225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 responses: '200': description: Response @@ -87202,7 +87243,7 @@ paths: items: *4 teams: type: array - items: *172 + items: *178 required: - users - teams @@ -87243,7 +87284,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87261,9 +87302,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -87300,7 +87341,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *447 examples: default: value: @@ -87836,9 +87877,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: true content: @@ -87872,7 +87913,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *447 examples: default: value: @@ -88377,9 +88418,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 - *17 - *19 responses: @@ -88389,7 +88430,7 @@ paths: application/json: schema: type: array - items: &552 + items: &556 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -88463,7 +88504,7 @@ paths: type: string body_text: type: string - author_association: *65 + author_association: *69 required: - id - node_id @@ -88512,7 +88553,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88545,9 +88586,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -88637,9 +88678,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: &554 + default: &558 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88702,10 +88743,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 - - &553 + - *316 + - *317 + - *553 + - &557 name: review_id description: The unique identifier of the review. in: path @@ -88717,9 +88758,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: &555 + default: &559 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -88778,10 +88819,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 requestBody: required: true content: @@ -88804,7 +88845,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: default: value: @@ -88866,18 +88907,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 responses: '200': description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: *554 + default: *558 '422': *7 '404': *6 x-github: @@ -88904,10 +88945,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 - *17 - *19 responses: @@ -89001,13 +89042,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *65 + author_association: *69 _links: type: object properties: - self: *245 - html: *245 - pull_request: *245 + self: *251 + html: *251 + pull_request: *251 required: - self - html @@ -89016,7 +89057,7 @@ paths: type: string body_html: type: string - reactions: *66 + reactions: *70 side: description: The side of the first line of the range for a multi-line comment. @@ -89136,7 +89177,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -89165,10 +89206,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 requestBody: required: true content: @@ -89197,7 +89238,7 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: default: value: @@ -89260,10 +89301,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *311 - - *312 - - *549 + - *316 + - *317 - *553 + - *557 requestBody: required: true content: @@ -89298,9 +89339,9 @@ paths: description: Response content: application/json: - schema: *552 + schema: *556 examples: - default: *555 + default: *559 '404': *6 '422': *7 '403': *27 @@ -89322,9 +89363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *311 - - *312 - - *549 + - *316 + - *317 + - *553 requestBody: required: false content: @@ -89388,8 +89429,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *311 - - *312 + - *316 + - *317 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -89402,9 +89443,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *560 examples: - default: &557 + default: &561 value: type: file encoding: base64 @@ -89446,8 +89487,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *311 - - *312 + - *316 + - *317 - name: dir description: The alternate path to look for a README file in: path @@ -89467,9 +89508,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *560 examples: - default: *557 + default: *561 '404': *6 '422': *15 x-github: @@ -89491,8 +89532,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -89502,7 +89543,7 @@ paths: application/json: schema: type: array - items: &558 + items: &562 title: Release description: A release. type: object @@ -89584,7 +89625,7 @@ paths: author: *4 assets: type: array - items: &559 + items: &563 title: Release Asset description: Data related to a release. type: object @@ -89659,7 +89700,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *66 + reactions: *70 required: - assets_url - upload_url @@ -89751,7 +89792,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -89771,8 +89812,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -89848,9 +89889,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: &562 + default: &566 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -89955,9 +89996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *311 - - *312 - - &560 + - *316 + - *317 + - &564 name: asset_id description: The unique identifier of the asset. in: path @@ -89969,9 +90010,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *563 examples: - default: &561 + default: &565 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 @@ -90006,7 +90047,7 @@ paths: type: User site_admin: false '404': *6 - '302': *452 + '302': *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90022,9 +90063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *311 - - *312 - - *560 + - *316 + - *317 + - *564 requestBody: required: false content: @@ -90053,9 +90094,9 @@ paths: description: Response content: application/json: - schema: *559 + schema: *563 examples: - default: *561 + default: *565 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90071,9 +90112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *311 - - *312 - - *560 + - *316 + - *317 + - *564 responses: '204': description: Response @@ -90097,8 +90138,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -90184,16 +90225,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: *562 + default: *566 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90210,8 +90251,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *311 - - *312 + - *316 + - *317 - name: tag description: tag parameter in: path @@ -90224,9 +90265,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: *562 + default: *566 '404': *6 x-github: githubCloudOnly: false @@ -90248,9 +90289,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *311 - - *312 - - &563 + - *316 + - *317 + - &567 name: release_id description: The unique identifier of the release. in: path @@ -90264,9 +90305,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: *562 examples: - default: *562 + default: *566 '401': description: Unauthorized x-github: @@ -90284,9 +90325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 requestBody: required: false content: @@ -90350,9 +90391,9 @@ paths: description: Response content: application/json: - schema: *558 + schema: *562 examples: - default: *562 + default: *566 '404': description: Not Found if the discussion category name is invalid content: @@ -90373,9 +90414,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 responses: '204': description: Response @@ -90395,9 +90436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 - *17 - *19 responses: @@ -90407,7 +90448,7 @@ paths: application/json: schema: type: array - items: *559 + items: *563 examples: default: value: @@ -90444,7 +90485,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90488,9 +90529,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: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 - name: name in: query required: true @@ -90516,7 +90557,7 @@ paths: description: Response for successful upload content: application/json: - schema: *559 + schema: *563 examples: response-for-successful-upload: value: @@ -90571,9 +90612,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 - 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. @@ -90597,11 +90638,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -90620,9 +90661,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *311 - - *312 - - *563 + - *316 + - *317 + - *567 requestBody: required: true content: @@ -90652,16 +90693,16 @@ paths: description: Reaction exists content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '201': description: Reaction created content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 '422': *15 x-github: githubCloudOnly: false @@ -90683,10 +90724,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *311 - - *312 - - *563 - - *307 + - *316 + - *317 + - *567 + - *314 responses: '204': description: Response @@ -90710,9 +90751,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *311 - - *312 - - *379 + - *316 + - *317 + - *383 - *17 - *19 responses: @@ -90728,8 +90769,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *263 - - &564 + - *269 + - &568 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -90748,69 +90789,69 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *264 - - *564 - - allOf: - - *265 - - *564 - - allOf: - - *266 - - *564 - - allOf: - - *565 - - *564 - - allOf: - - *267 - - *564 - - allOf: - - *268 - - *564 - - allOf: - - *269 - - *564 - allOf: - *270 - - *564 + - *568 - allOf: - *271 - - *564 + - *568 - allOf: - *272 - - *564 + - *568 + - allOf: + - *569 + - *568 - allOf: - *273 - - *564 + - *568 - allOf: - *274 - - *564 + - *568 - allOf: - *275 - - *564 + - *568 - allOf: - *276 - - *564 + - *568 - allOf: - *277 - - *564 + - *568 - allOf: - *278 - - *564 + - *568 - allOf: - *279 - - *564 + - *568 - allOf: - *280 - - *564 + - *568 - allOf: - *281 - - *564 + - *568 - allOf: - *282 - - *564 + - *568 + - allOf: + - *283 + - *568 + - allOf: + - *284 + - *568 + - allOf: + - *285 + - *568 - allOf: - - *566 - - *564 + - *286 + - *568 + - allOf: + - *287 + - *568 + - allOf: + - *288 + - *568 + - allOf: + - *289 + - *568 examples: default: value: @@ -90849,8 +90890,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - name: includes_parents @@ -90861,7 +90902,7 @@ paths: schema: type: boolean default: true - - *567 + - *570 responses: '200': description: Response @@ -90869,7 +90910,7 @@ paths: application/json: schema: type: array - items: *283 + items: *290 examples: default: value: @@ -90900,7 +90941,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -90916,8 +90957,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 requestBody: description: Request body required: true @@ -90937,16 +90978,16 @@ paths: - tag - push default: branch - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *258 + items: *267 + conditions: *264 rules: type: array description: An array of rules within the ruleset. - items: *568 + items: *571 required: - name - enforcement @@ -90977,9 +91018,9 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: &578 + default: &581 value: id: 42 name: super cool ruleset @@ -91012,7 +91053,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *96 + '500': *102 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -91026,12 +91067,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *311 - - *312 - - *569 - - *570 - - *571 + - *316 + - *317 - *572 + - *573 + - *574 + - *575 - *17 - *19 responses: @@ -91039,11 +91080,11 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *574 + default: *577 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91062,19 +91103,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *311 - - *312 - - *575 + - *316 + - *317 + - *578 responses: '200': description: Response content: application/json: - schema: *576 + schema: *579 examples: - default: *577 + default: *580 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91100,8 +91141,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91121,11 +91162,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *578 + default: *581 '404': *6 - '500': *96 + '500': *102 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -91141,8 +91182,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91167,16 +91208,16 @@ paths: - branch - tag - push - enforcement: *260 + enforcement: *266 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *261 - conditions: *258 + items: *267 + conditions: *264 rules: description: An array of rules within the ruleset. type: array - items: *568 + items: *571 examples: default: value: @@ -91204,11 +91245,11 @@ paths: description: Response content: application/json: - schema: *283 + schema: *290 examples: - default: *578 + default: *581 '404': *6 - '500': *96 + '500': *102 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -91224,8 +91265,8 @@ paths: category: repos subcategory: rules parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91236,7 +91277,7 @@ paths: '204': description: Response '404': *6 - '500': *96 + '500': *102 "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": get: summary: Get repository ruleset history @@ -91248,8 +91289,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 - name: ruleset_id @@ -91265,11 +91306,11 @@ paths: application/json: schema: type: array - items: *286 + items: *293 examples: - default: *579 + default: *582 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91286,8 +91327,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version parameters: - - *311 - - *312 + - *316 + - *317 - name: ruleset_id description: The ID of the ruleset. in: path @@ -91305,7 +91346,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *583 examples: default: value: @@ -91338,7 +91379,7 @@ paths: operator: contains pattern: github '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91360,21 +91401,22 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *311 - - *312 - - *581 - - *582 - - *583 + - *316 + - *317 - *584 - - *46 - - *19 - - *17 - *585 - *586 - *587 - *588 + - *50 + - *19 + - *17 - *589 - *590 + - *591 + - *592 + - *593 + - *594 responses: '200': description: Response @@ -91382,24 +91424,24 @@ paths: application/json: schema: type: array - items: &594 + items: &598 type: object properties: - number: *154 - created_at: *155 + number: *160 + created_at: *161 updated_at: anyOf: - type: 'null' - - *156 - url: *157 - html_url: *158 + - *162 + url: *163 + html_url: *164 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *591 - resolution: *592 + state: *595 + resolution: *596 resolved_at: type: - string @@ -91493,7 +91535,7 @@ paths: first_location_detected: anyOf: - type: 'null' - - *593 + - *597 has_more_locations: type: boolean description: A boolean value representing whether or not the @@ -91616,7 +91658,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91638,16 +91680,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *311 - - *312 - - *410 - - *590 + - *316 + - *317 + - *414 + - *594 responses: '200': description: Response content: application/json: - schema: *594 + schema: *598 examples: default: value: @@ -91678,7 +91720,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91689,6 +91731,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. 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. @@ -91699,9 +91743,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 requestBody: required: true content: @@ -91709,28 +91753,44 @@ paths: schema: type: object properties: - state: *591 - resolution: *592 + state: *595 + resolution: *596 resolution_comment: description: An optional comment when closing or reopening an alert. Cannot be updated or deleted. type: - string - 'null' + assignee: + description: The username of the user to assign to the alert. Set + to `null` to unassign the alert. + type: + - string + - 'null' anyOf: - required: - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response content: application/json: - schema: *594 + schema: *598 examples: default: value: @@ -91775,6 +91835,25 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + 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 '400': description: Bad request, resolution comment is invalid or the resolution was not changed. @@ -91782,8 +91861,9 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment - '503': *97 + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -91805,9 +91885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *311 - - *312 - - *410 + - *316 + - *317 + - *414 - *19 - *17 responses: @@ -91818,7 +91898,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &740 + items: &751 type: object properties: type: @@ -91845,10 +91925,6 @@ paths: - commit details: oneOf: - - *595 - - *596 - - *597 - - *598 - *599 - *600 - *601 @@ -91858,6 +91934,10 @@ paths: - *605 - *606 - *607 + - *608 + - *609 + - *610 + - *611 examples: default: value: @@ -91917,11 +91997,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *52 + Link: *56 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91943,8 +92023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -91952,14 +92032,14 @@ paths: schema: type: object properties: - reason: &609 + reason: &613 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *608 + placeholder_id: *612 required: - reason - placeholder_id @@ -91976,7 +92056,7 @@ paths: schema: type: object properties: - reason: *609 + reason: *613 expire_at: type: - string @@ -92000,7 +92080,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *97 + '503': *103 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -92023,13 +92103,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: - - *311 - - *312 + - *316 + - *317 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *97 + '503': *103 '200': description: Response content: @@ -92039,7 +92119,7 @@ paths: properties: incremental_scans: type: array - items: &610 + items: &614 description: Information on a single scan performed by secret scanning on the repository type: object @@ -92067,15 +92147,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *610 + items: *614 backfill_scans: type: array - items: *610 + items: *614 custom_pattern_backfill_scans: type: array items: allOf: - - *610 + - *614 - type: object properties: pattern_name: @@ -92145,9 +92225,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *311 - - *312 - - *46 + - *316 + - *317 + - *50 - name: sort description: The property to sort the results by. in: query @@ -92159,8 +92239,8 @@ paths: - updated - published default: created - - *38 - - *39 + - *43 + - *44 - 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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -92190,9 +92270,9 @@ paths: application/json: schema: type: array - items: *611 + items: *615 examples: - default: *612 + default: *616 '400': *14 '404': *6 x-github: @@ -92215,8 +92295,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -92296,7 +92376,7 @@ paths: login: type: string description: The username of the user credited. - type: *289 + type: *296 required: - login - type @@ -92386,9 +92466,9 @@ paths: description: Response content: application/json: - schema: *611 + schema: *615 examples: - default: &614 + default: &618 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -92621,8 +92701,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -92735,7 +92815,7 @@ paths: description: Response content: application/json: - schema: *611 + schema: *615 examples: default: value: @@ -92882,17 +92962,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 responses: '200': description: Response content: application/json: - schema: *611 + schema: *615 examples: - default: *614 + default: *618 '403': *27 '404': *6 x-github: @@ -92916,9 +92996,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 requestBody: required: true content: @@ -92998,7 +93078,7 @@ paths: login: type: string description: The username of the user credited. - type: *289 + type: *296 required: - login - type @@ -93089,17 +93169,17 @@ paths: description: Response content: application/json: - schema: *611 + schema: *615 examples: - default: *614 - add_credit: *614 + default: *618 + add_credit: *618 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *105 + schema: *111 examples: invalid_state_transition: value: @@ -93130,9 +93210,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: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 responses: '202': *37 '400': *14 @@ -93159,17 +93239,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *311 - - *312 - - *613 + - *316 + - *317 + - *617 responses: '202': description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 '400': *14 '422': *15 '403': *27 @@ -93195,8 +93275,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -93270,7 +93350,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -93292,8 +93372,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -93302,7 +93382,7 @@ paths: application/json: schema: type: array - items: &615 + items: &619 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -93315,7 +93395,7 @@ paths: - 1124 - -435 '202': *37 - '204': *168 + '204': *174 '422': description: Repository contains more than 10,000 commits x-github: @@ -93335,8 +93415,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -93387,7 +93467,7 @@ paths: total: 89 week: 1336280400 '202': *37 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93414,8 +93494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -93487,7 +93567,7 @@ paths: d: 77 c: 10 '202': *37 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93509,8 +93589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -93664,8 +93744,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -93675,7 +93755,7 @@ paths: application/json: schema: type: array - items: *615 + items: *619 examples: default: value: @@ -93688,7 +93768,7 @@ paths: - - 0 - 2 - 21 - '204': *168 + '204': *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93708,8 +93788,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *311 - - *312 + - *316 + - *317 - name: sha in: path required: true @@ -93765,7 +93845,7 @@ paths: description: Response content: application/json: - schema: *616 + schema: *620 examples: default: value: @@ -93819,8 +93899,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -93832,9 +93912,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -93852,14 +93932,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &617 + schema: &621 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -93932,8 +94012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: false content: @@ -93959,7 +94039,7 @@ paths: description: Response content: application/json: - schema: *617 + schema: *621 examples: default: value: @@ -93986,8 +94066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -94007,8 +94087,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -94067,7 +94147,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -94090,8 +94170,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -94099,7 +94179,7 @@ paths: application/json: schema: type: array - items: &618 + items: &622 title: Tag protection description: Tag protection type: object @@ -94156,8 +94236,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: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -94180,7 +94260,7 @@ paths: description: Response content: application/json: - schema: *618 + schema: *622 examples: default: value: @@ -94211,8 +94291,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: - - *311 - - *312 + - *316 + - *317 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -94249,8 +94329,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *311 - - *312 + - *316 + - *317 - name: ref in: path required: true @@ -94286,8 +94366,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *311 - - *312 + - *316 + - *317 - *17 - *19 responses: @@ -94297,11 +94377,11 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - default: *224 + default: *230 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -94319,8 +94399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *311 - - *312 + - *316 + - *317 - *19 - *17 responses: @@ -94328,7 +94408,7 @@ paths: description: Response content: application/json: - schema: &619 + schema: &623 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -94340,7 +94420,7 @@ paths: required: - names examples: - default: &620 + default: &624 value: names: - octocat @@ -94363,8 +94443,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -94395,9 +94475,9 @@ paths: description: Response content: application/json: - schema: *619 + schema: *623 examples: - default: *620 + default: *624 '404': *6 '422': *7 x-github: @@ -94418,9 +94498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *311 - - *312 - - &621 + - *316 + - *317 + - &625 name: per description: The time frame to display results for. in: query @@ -94451,7 +94531,7 @@ paths: - 128 clones: type: array - items: &622 + items: &626 title: Traffic type: object properties: @@ -94538,8 +94618,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -94633,8 +94713,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *311 - - *312 + - *316 + - *317 responses: '200': description: Response @@ -94697,9 +94777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *311 - - *312 - - *621 + - *316 + - *317 + - *625 responses: '200': description: Response @@ -94720,7 +94800,7 @@ paths: - 3782 views: type: array - items: *622 + items: *626 required: - uniques - count @@ -94797,8 +94877,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *311 - - *312 + - *316 + - *317 requestBody: required: true content: @@ -94834,7 +94914,7 @@ paths: description: Response content: application/json: - schema: *136 + schema: *142 examples: default: value: @@ -95072,8 +95152,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -95096,8 +95176,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -95119,8 +95199,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -95146,8 +95226,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *311 - - *312 + - *316 + - *317 - name: ref in: path required: true @@ -95239,9 +95319,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95282,7 +95362,7 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: default: value: @@ -95471,7 +95551,7 @@ paths: html_url: type: string format: uri - repository: *136 + repository: *142 score: type: number file_size: @@ -95490,7 +95570,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &623 + text_matches: &627 title: Search Result Text Matches type: array items: @@ -95605,7 +95685,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *97 + '503': *103 '422': *15 '403': *27 x-github: @@ -95653,7 +95733,7 @@ paths: enum: - author-date - committer-date - - &624 + - &628 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 @@ -95722,7 +95802,7 @@ paths: committer: anyOf: - type: 'null' - - *377 + - *381 comment_count: type: integer message: @@ -95741,7 +95821,7 @@ paths: url: type: string format: uri - verification: *488 + verification: *492 required: - author - committer @@ -95756,7 +95836,7 @@ paths: committer: anyOf: - type: 'null' - - *377 + - *381 parents: type: array items: @@ -95768,12 +95848,12 @@ paths: type: string sha: type: string - repository: *136 + repository: *142 score: type: number node_id: type: string - text_matches: *623 + text_matches: *627 required: - sha - node_id @@ -95965,7 +96045,7 @@ paths: - interactions - created - updated - - *624 + - *628 - *17 - *19 - name: advanced_search @@ -96062,11 +96142,11 @@ paths: type: - string - 'null' - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: type: string state_reason: @@ -96080,7 +96160,7 @@ paths: milestone: anyOf: - type: 'null' - - *244 + - *250 comments: type: integer created_at: @@ -96094,7 +96174,7 @@ paths: - string - 'null' format: date-time - text_matches: *623 + text_matches: *627 pull_request: type: object properties: @@ -96132,10 +96212,10 @@ paths: type: string score: type: number - author_association: *65 + author_association: *69 draft: type: boolean - repository: *64 + repository: *68 body_html: type: string body_text: @@ -96143,12 +96223,12 @@ paths: timeline_url: type: string format: uri - type: *208 + type: *214 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *66 + reactions: *70 required: - assignee - closed_at @@ -96264,7 +96344,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *97 + '503': *103 '422': *15 '304': *35 '403': *27 @@ -96317,7 +96397,7 @@ paths: enum: - created - updated - - *624 + - *628 - *17 - *19 responses: @@ -96362,7 +96442,7 @@ paths: - 'null' score: type: number - text_matches: *623 + text_matches: *627 required: - id - node_id @@ -96447,7 +96527,7 @@ paths: - forks - help-wanted-issues - updated - - *624 + - *628 - *17 - *19 responses: @@ -96666,7 +96746,7 @@ paths: license: anyOf: - type: 'null' - - *79 + - *83 permissions: type: object properties: @@ -96684,7 +96764,7 @@ paths: - admin - pull - push - text_matches: *623 + text_matches: *627 temp_clone_token: type: string allow_merge_commit: @@ -96887,7 +96967,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *97 + '503': *103 '422': *15 '304': *35 x-github: @@ -96992,7 +97072,7 @@ paths: - string - 'null' format: uri - text_matches: *623 + text_matches: *627 related: type: - array @@ -97185,7 +97265,7 @@ paths: - followers - repositories - joined - - *624 + - *628 - *17 - *19 responses: @@ -97295,7 +97375,7 @@ paths: type: - boolean - 'null' - text_matches: *623 + text_matches: *627 blog: type: - string @@ -97357,7 +97437,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *97 + '503': *103 '422': *15 x-github: githubCloudOnly: false @@ -97377,7 +97457,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &628 + - &632 name: team_id description: The unique identifier of the team. in: path @@ -97389,9 +97469,9 @@ paths: description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 x-github: githubCloudOnly: false @@ -97418,7 +97498,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *628 + - *632 requestBody: required: true content: @@ -97482,16 +97562,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '201': description: Response content: application/json: - schema: *296 + schema: *303 examples: - default: *297 + default: *304 '404': *6 '422': *15 '403': *27 @@ -97519,7 +97599,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *628 + - *632 responses: '204': description: Response @@ -97550,8 +97630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *628 - - *46 + - *632 + - *50 - *17 - *19 responses: @@ -97561,11 +97641,11 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *629 + default: *633 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97592,7 +97672,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *628 + - *632 requestBody: required: true content: @@ -97626,9 +97706,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: triggersNotification: true githubCloudOnly: false @@ -97655,16 +97735,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97689,8 +97769,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 requestBody: required: false content: @@ -97713,9 +97793,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *630 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97740,8 +97820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 responses: '204': description: Response @@ -97770,9 +97850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *628 - - *300 - - *46 + - *632 + - *307 + - *50 - *17 - *19 responses: @@ -97782,11 +97862,11 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *631 + default: *635 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97813,8 +97893,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *628 - - *300 + - *632 + - *307 requestBody: required: true content: @@ -97836,9 +97916,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: triggersNotification: true githubCloudOnly: false @@ -97865,17 +97945,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 responses: '200': description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97900,9 +97980,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 requestBody: required: true content: @@ -97924,9 +98004,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *632 + default: *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97951,9 +98031,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 responses: '204': description: Response @@ -97982,9 +98062,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 - 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. @@ -98010,11 +98090,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98041,9 +98121,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *628 - - *300 - - *303 + - *632 + - *307 + - *310 requestBody: required: true content: @@ -98075,9 +98155,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98103,8 +98183,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 - 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. @@ -98130,11 +98210,11 @@ paths: application/json: schema: type: array - items: *304 + items: *311 examples: - default: *306 + default: *313 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98161,8 +98241,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *628 - - *300 + - *632 + - *307 requestBody: required: true content: @@ -98194,9 +98274,9 @@ paths: description: Response content: application/json: - schema: *304 + schema: *311 examples: - default: *305 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98220,7 +98300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *628 + - *632 - *17 - *19 responses: @@ -98230,11 +98310,11 @@ paths: application/json: schema: type: array - items: *205 + items: *211 examples: - default: *206 + default: *212 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98258,7 +98338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *628 + - *632 - name: role description: Filters members returned by their role in the team. in: query @@ -98281,9 +98361,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -98309,8 +98389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: if user is a member @@ -98346,8 +98426,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: Response @@ -98386,8 +98466,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: Response @@ -98423,16 +98503,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '200': description: Response content: application/json: - schema: *308 + schema: *315 examples: - response-if-user-is-a-team-maintainer: *633 + response-if-user-is-a-team-maintainer: *637 '404': *6 x-github: githubCloudOnly: false @@ -98465,8 +98545,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *628 - - *57 + - *632 + - *61 requestBody: required: false content: @@ -98491,9 +98571,9 @@ paths: description: Response content: application/json: - schema: *308 + schema: *315 examples: - response-if-users-membership-with-team-is-now-pending: *634 + response-if-users-membership-with-team-is-now-pending: *638 '403': description: Forbidden if team synchronization is set up '422': @@ -98527,8 +98607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *628 - - *57 + - *632 + - *61 responses: '204': description: Response @@ -98542,174 +98622,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - *628 - - *17 - - *19 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *309 - examples: - default: *635 - headers: - Link: *52 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - *628 - - *310 - responses: - '200': - description: Response - content: - application/json: - schema: *309 - examples: - default: *636 - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - *628 - - *310 - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Closing down notice:** Projects (classic) is being deprecated in favor of the new Projects experience. - > See the [changelog](https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/) for more information. - tags: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - *628 - - *310 - responses: - '204': - description: Response - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2025-04-01' - deprecationDate: '2024-05-23' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -98723,7 +98635,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *628 + - *632 - *17 - *19 responses: @@ -98733,11 +98645,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -98765,15 +98677,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *628 - - *311 - - *312 + - *632 + - *316 + - *317 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *637 + schema: *639 examples: alternative-response-with-extra-repository-information: value: @@ -98924,9 +98836,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *628 - - *311 - - *312 + - *632 + - *316 + - *317 requestBody: required: false content: @@ -98976,9 +98888,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *628 - - *311 - - *312 + - *632 + - *316 + - *317 responses: '204': description: Response @@ -99003,7 +98915,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *628 + - *632 - *17 - *19 responses: @@ -99013,11 +98925,11 @@ paths: application/json: schema: type: array - items: *172 + items: *178 examples: - response-if-child-teams-exist: *638 + response-if-child-teams-exist: *640 headers: - Link: *52 + Link: *56 '404': *6 '403': *27 '422': *15 @@ -99048,7 +98960,7 @@ paths: application/json: schema: oneOf: - - &640 + - &642 title: Private User description: Private User type: object @@ -99298,7 +99210,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *639 + - *641 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -99458,7 +99370,7 @@ paths: description: Response content: application/json: - schema: *640 + schema: *642 examples: default: value: @@ -99537,7 +99449,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 '304': *35 '404': *6 '403': *27 @@ -99560,7 +99472,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: - - *57 + - *61 responses: '204': description: If the user is blocked @@ -99588,7 +99500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -99612,7 +99524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -99661,11 +99573,11 @@ paths: type: integer codespaces: type: array - items: *213 + items: *219 examples: - default: *214 + default: *220 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -99802,21 +99714,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '401': *23 '403': *27 '404': *6 - '503': *97 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99856,7 +99768,7 @@ paths: type: integer secrets: type: array - items: &641 + items: &643 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -99898,9 +99810,9 @@ paths: - visibility - selected_repositories_url examples: - default: *432 + default: *436 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -99970,13 +99882,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *144 + - *150 responses: '200': description: Response content: application/json: - schema: *641 + schema: *643 examples: default: value: @@ -100006,7 +99918,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *144 + - *150 requestBody: required: true content: @@ -100051,7 +99963,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -100079,7 +99991,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *144 + - *150 responses: '204': description: Response @@ -100104,7 +100016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *144 + - *150 responses: '200': description: Response @@ -100120,13 +100032,13 @@ paths: type: integer repositories: type: array - items: *136 + items: *142 examples: - default: *642 + default: *644 '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100147,7 +100059,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *144 + - *150 requestBody: required: true content: @@ -100179,7 +100091,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100201,7 +100113,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *144 + - *150 - name: repository_id in: path required: true @@ -100213,7 +100125,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100234,7 +100146,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *144 + - *150 - name: repository_id in: path required: true @@ -100246,7 +100158,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *96 + '500': *102 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100266,17 +100178,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100300,7 +100212,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 requestBody: required: false content: @@ -100330,9 +100242,9 @@ paths: description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '401': *23 '403': *27 '404': *6 @@ -100354,11 +100266,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '202': *37 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100383,13 +100295,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '202': description: Response content: application/json: - schema: &643 + schema: &645 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -100442,7 +100354,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &644 + default: &646 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -100450,7 +100362,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100474,7 +100386,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *215 + - *221 - name: export_id in: path required: true @@ -100487,9 +100399,9 @@ paths: description: Response content: application/json: - schema: *643 + schema: *645 examples: - default: *644 + default: *646 '404': *6 x-github: githubCloudOnly: false @@ -100510,7 +100422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *215 + - *221 responses: '200': description: Response @@ -100526,11 +100438,11 @@ paths: type: integer machines: type: array - items: *431 + items: *435 examples: - default: *645 + default: *647 '304': *35 - '500': *96 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -100557,7 +100469,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *215 + - *221 requestBody: required: true content: @@ -100613,11 +100525,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *317 + repository: *319 machine: anyOf: - type: 'null' - - *431 + - *435 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -101414,17 +101326,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 + default: *434 '304': *35 - '500': *96 + '500': *102 '400': *14 '401': *23 '402': @@ -101434,7 +101346,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *45 + '409': *49 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101454,16 +101366,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *215 + - *221 responses: '200': description: Response content: application/json: - schema: *213 + schema: *219 examples: - default: *430 - '500': *96 + default: *434 + '500': *102 '401': *23 '403': *27 '404': *6 @@ -101492,9 +101404,9 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: &656 + default: &658 value: - id: 197 name: hello_docker @@ -101595,7 +101507,7 @@ paths: application/json: schema: type: array - items: &646 + items: &648 title: Email description: Email type: object @@ -101665,16 +101577,16 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: &658 + default: &660 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -101744,7 +101656,7 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: default: value: @@ -101856,9 +101768,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -101889,9 +101801,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -101911,7 +101823,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: - - *57 + - *61 responses: '204': description: if the person is followed by the authenticated user @@ -101941,7 +101853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -101966,7 +101878,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *57 + - *61 responses: '204': description: Response @@ -102002,7 +101914,7 @@ paths: application/json: schema: type: array - items: &647 + items: &649 title: GPG Key description: A unique encryption key type: object @@ -102147,7 +102059,7 @@ paths: - subkeys - revoked examples: - default: &672 + default: &674 value: - id: 3 name: Octocat's GPG Key @@ -102179,7 +102091,7 @@ paths: revoked: false raw_key: string headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -102232,9 +102144,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *649 examples: - default: &648 + default: &650 value: id: 3 name: Octocat's GPG Key @@ -102291,7 +102203,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &649 + - &651 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -102303,9 +102215,9 @@ paths: description: Response content: application/json: - schema: *647 + schema: *649 examples: - default: *648 + default: *650 '404': *6 '304': *35 '403': *27 @@ -102328,7 +102240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *649 + - *651 responses: '204': description: Response @@ -102471,7 +102383,7 @@ paths: suspended_at: suspended_by: headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -102517,11 +102429,11 @@ paths: type: string repositories: type: array - items: *64 + items: *68 examples: - default: *128 + default: *134 headers: - Link: *52 + Link: *56 '404': *6 '403': *27 '304': *35 @@ -102544,7 +102456,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *125 + - *131 responses: '204': description: Response @@ -102570,7 +102482,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *125 + - *131 responses: '204': description: Response @@ -102604,12 +102516,12 @@ paths: application/json: schema: anyOf: - - *203 + - *209 - type: object properties: {} additionalProperties: false examples: - default: *204 + default: *210 '204': description: Response when there are no restrictions x-github: @@ -102633,7 +102545,7 @@ paths: required: true content: application/json: - schema: *499 + schema: *503 examples: default: value: @@ -102644,7 +102556,7 @@ paths: description: Response content: application/json: - schema: *203 + schema: *209 examples: default: value: @@ -102725,7 +102637,7 @@ paths: - closed - all default: open - - *211 + - *217 - name: sort description: What to sort results by. in: query @@ -102737,8 +102649,8 @@ paths: - updated - comments default: created - - *46 - - *68 + - *50 + - *72 - *17 - *19 responses: @@ -102748,11 +102660,11 @@ paths: application/json: schema: type: array - items: *78 + items: *82 examples: - default: *212 + default: *218 headers: - Link: *52 + Link: *56 '404': *6 '304': *35 x-github: @@ -102783,7 +102695,7 @@ paths: application/json: schema: type: array - items: &650 + items: &652 title: Key description: Key type: object @@ -102835,7 +102747,7 @@ paths: verified: false read_only: false headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -102886,9 +102798,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *652 examples: - default: &651 + default: &653 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -102921,15 +102833,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *531 responses: '200': description: Response content: application/json: - schema: *650 + schema: *652 examples: - default: *651 + default: *653 '404': *6 '304': *35 '403': *27 @@ -102952,7 +102864,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *527 + - *531 responses: '204': description: Response @@ -102985,7 +102897,7 @@ paths: application/json: schema: type: array - items: &652 + items: &654 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -103053,7 +102965,7 @@ paths: - id - type - login - plan: *81 + plan: *85 required: - billing_cycle - next_billing_date @@ -103064,7 +102976,7 @@ paths: - account - plan examples: - default: &653 + default: &655 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -103097,7 +103009,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *52 + Link: *56 '304': *35 '401': *23 '404': *6 @@ -103126,11 +103038,11 @@ paths: application/json: schema: type: array - items: *652 + items: *654 examples: - default: *653 + default: *655 headers: - Link: *52 + Link: *56 '304': *35 '401': *23 x-github: @@ -103168,7 +103080,7 @@ paths: application/json: schema: type: array - items: *217 + items: *223 examples: default: value: @@ -103245,7 +103157,7 @@ paths: type: User site_admin: false headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -103270,13 +103182,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *61 + - *65 responses: '200': description: Response content: application/json: - schema: *217 + schema: *223 examples: default: value: @@ -103334,7 +103246,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *61 + - *65 requestBody: required: true content: @@ -103359,7 +103271,7 @@ paths: description: Response content: application/json: - schema: *217 + schema: *223 examples: default: value: @@ -103427,7 +103339,7 @@ paths: application/json: schema: type: array - items: *219 + items: *225 examples: default: value: @@ -103580,7 +103492,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -103689,7 +103601,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -103869,7 +103781,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *220 + - *226 - name: exclude in: query required: false @@ -103882,7 +103794,7 @@ paths: description: Response content: application/json: - schema: *219 + schema: *225 examples: default: value: @@ -104076,7 +103988,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *220 + - *226 responses: '302': description: Response @@ -104102,7 +104014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *220 + - *226 responses: '204': description: Response @@ -104131,8 +104043,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *220 - - *654 + - *226 + - *656 responses: '204': description: Response @@ -104156,7 +104068,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *220 + - *226 - *17 - *19 responses: @@ -104166,11 +104078,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 '404': *6 x-github: githubCloudOnly: false @@ -104203,11 +104115,11 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: *94 + default: *98 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -104247,7 +104159,7 @@ paths: - docker - nuget - container - - *655 + - *657 - *19 - *17 responses: @@ -104257,10 +104169,10 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *656 - '400': *657 + default: *658 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -104280,16 +104192,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *227 - - *228 + - *233 + - *234 responses: '200': description: Response content: application/json: - schema: *225 + schema: *231 examples: - default: &673 + default: &675 value: id: 40201 name: octo-name @@ -104402,8 +104314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *227 - - *228 + - *233 + - *234 responses: '204': description: Response @@ -104433,8 +104345,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *227 - - *228 + - *233 + - *234 - name: token description: package token schema: @@ -104466,8 +104378,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: - - *227 - - *228 + - *233 + - *234 - *19 - *17 - name: state @@ -104487,7 +104399,7 @@ paths: application/json: schema: type: array - items: *229 + items: *235 examples: default: value: @@ -104536,15 +104448,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *227 - - *228 - - *230 + - *233 + - *234 + - *236 responses: '200': description: Response content: application/json: - schema: *229 + schema: *235 examples: default: value: @@ -104580,9 +104492,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *227 - - *228 - - *230 + - *233 + - *234 + - *236 responses: '204': description: Response @@ -104612,9 +104524,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *227 - - *228 - - *230 + - *233 + - *234 + - *236 responses: '204': description: Response @@ -104651,11 +104563,11 @@ paths: application/json: schema: type: array - items: *646 + items: *648 examples: - default: *658 + default: *660 headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -104764,9 +104676,9 @@ paths: application/json: schema: type: array - items: *64 + items: *68 examples: - default: &665 + default: &667 summary: Default response value: - id: 1296269 @@ -104887,7 +104799,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *52 + Link: *56 '422': *15 '304': *35 '403': *27 @@ -105084,9 +104996,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *319 examples: - default: *319 + default: *321 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -105124,11 +105036,11 @@ paths: application/json: schema: type: array - items: *501 + items: *505 examples: - default: *659 + default: *661 headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105149,12 +105061,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *207 + - *213 responses: '204': description: Response '403': *27 - '409': *45 + '409': *49 '404': *6 '304': *35 x-github: @@ -105172,11 +105084,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *207 + - *213 responses: '204': description: Response - '409': *45 + '409': *49 '304': *35 '404': *6 '403': *27 @@ -105205,7 +105117,7 @@ paths: application/json: schema: type: array - items: &660 + items: &662 title: Social account description: Social media account type: object @@ -105222,12 +105134,12 @@ paths: - provider - url examples: - default: &661 + default: &663 value: - provider: twitter url: https://twitter.com/github headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105285,9 +105197,9 @@ paths: application/json: schema: type: array - items: *660 + items: *662 examples: - default: *661 + default: *663 '422': *15 '304': *35 '404': *6 @@ -105375,7 +105287,7 @@ paths: application/json: schema: type: array - items: &662 + items: &664 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -105395,7 +105307,7 @@ paths: - title - created_at examples: - default: &681 + default: &692 value: - id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105406,7 +105318,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105460,9 +105372,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: &663 + default: &665 value: id: 2 key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -105492,7 +105404,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: - - &664 + - &666 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -105504,9 +105416,9 @@ paths: description: Response content: application/json: - schema: *662 + schema: *664 examples: - default: *663 + default: *665 '404': *6 '304': *35 '403': *27 @@ -105529,7 +105441,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: - - *664 + - *666 responses: '204': description: Response @@ -105558,7 +105470,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &682 + - &693 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 @@ -105571,7 +105483,7 @@ paths: - created - updated default: created - - *46 + - *50 - *17 - *19 responses: @@ -105581,13 +105493,13 @@ paths: application/json: schema: type: array - items: *64 + items: *68 examples: - default-response: *665 + default-response: *667 application/vnd.github.v3.star+json: schema: type: array - items: &683 + items: &694 title: Starred Repository description: Starred Repository type: object @@ -105595,7 +105507,7 @@ paths: starred_at: type: string format: date-time - repo: *64 + repo: *68 required: - starred_at - repo @@ -105723,7 +105635,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -105743,8 +105655,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: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response if this repository is starred by you @@ -105772,8 +105684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -105797,8 +105709,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *311 - - *312 + - *316 + - *317 responses: '204': description: Response @@ -105831,11 +105743,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -105870,7 +105782,7 @@ paths: application/json: schema: type: array - items: *296 + items: *303 examples: default: value: @@ -105921,7 +105833,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *52 + Link: *56 '304': *35 '404': *6 '403': *27 @@ -105948,7 +105860,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *83 + - *87 responses: '200': description: Response @@ -105956,10 +105868,10 @@ paths: application/json: schema: oneOf: - - *640 - - *639 + - *642 + - *641 examples: - default-response: &667 + default-response: &669 summary: Default response value: login: octocat @@ -105994,7 +105906,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &668 + response-with-git-hub-plan-information: &670 summary: Response with GitHub plan information value: login: octocat @@ -106057,7 +105969,7 @@ paths: required: true schema: type: string - - *243 + - *249 requestBody: required: true description: Details of the draft item to create in the project. @@ -106091,9 +106003,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *254 examples: - draft_issue: *249 + draft_issue: *255 '304': *35 '403': *27 '401': *23 @@ -106116,7 +106028,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *666 + - *668 - *17 responses: '200': @@ -106127,7 +106039,7 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: Link: example: ; rel="next" @@ -106157,7 +106069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *57 + - *61 responses: '200': description: Response @@ -106165,11 +106077,11 @@ paths: application/json: schema: oneOf: - - *640 - - *639 + - *642 + - *641 examples: - default-response: *667 - response-with-git-hub-plan-information: *668 + default-response: *669 + response-with-git-hub-plan-information: *670 '404': *6 x-github: githubCloudOnly: false @@ -106193,9 +106105,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests parameters: - *17 - - *38 - - *39 - - *57 + - *43 + - *44 + - *61 requestBody: required: true content: @@ -106219,8 +106131,8 @@ paths: required: - subject_digests examples: - default: *669 - withPredicateType: *670 + default: *671 + withPredicateType: *672 responses: '200': description: Response @@ -106274,7 +106186,7 @@ paths: description: The cursor to the previous page. description: Information about the current page. examples: - default: *671 + default: *673 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106292,7 +106204,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk parameters: - - *57 + - *61 requestBody: required: true content: @@ -106357,7 +106269,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest parameters: - - *57 + - *61 - name: subject_digest description: Subject Digest in: path @@ -106388,7 +106300,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id parameters: - - *57 + - *61 - name: attestation_id description: Attestation ID in: path @@ -106424,9 +106336,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *17 - - *38 - - *39 - - *57 + - *43 + - *44 + - *61 - name: subject_digest description: Subject Digest in: path @@ -106479,12 +106391,12 @@ paths: initiator: type: string examples: - default: *373 + default: *377 '201': description: Response content: application/json: - schema: *145 + schema: *151 examples: default: value: @@ -106510,7 +106422,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: - - *57 + - *61 responses: '200': description: Response @@ -106518,9 +106430,9 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *656 + default: *658 '403': *27 '401': *23 x-github: @@ -106543,7 +106455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106553,7 +106465,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -106615,8 +106527,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *57 - *61 + - *65 - *17 - *19 responses: @@ -106626,7 +106538,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -106703,7 +106615,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106713,7 +106625,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -106771,7 +106683,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106783,9 +106695,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106802,7 +106714,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106814,9 +106726,9 @@ paths: type: array items: *4 examples: - default: *56 + default: *60 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106833,7 +106745,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *57 + - *61 - name: target_user in: path required: true @@ -106860,8 +106772,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *57 - - *68 + - *61 + - *72 - *17 - *19 responses: @@ -106871,11 +106783,11 @@ paths: application/json: schema: type: array - items: *69 + items: *73 examples: - default: *70 + default: *74 headers: - Link: *52 + Link: *56 '422': *15 x-github: githubCloudOnly: false @@ -106894,7 +106806,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -106904,11 +106816,11 @@ paths: application/json: schema: type: array - items: *647 + items: *649 examples: - default: *672 + default: *674 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -106930,7 +106842,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *57 + - *61 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -107002,7 +106914,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *57 + - *61 responses: '200': description: Response @@ -107010,7 +106922,7 @@ paths: application/json: schema: *20 examples: - default: *498 + default: *502 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107028,7 +106940,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107064,7 +106976,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107084,7 +106996,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107094,11 +107006,11 @@ paths: application/json: schema: type: array - items: *59 + items: *63 examples: - default: *94 + default: *98 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -107135,8 +107047,8 @@ paths: - docker - nuget - container - - *655 - - *57 + - *657 + - *61 - *19 - *17 responses: @@ -107146,12 +107058,12 @@ paths: application/json: schema: type: array - items: *225 + items: *231 examples: - default: *656 + default: *658 '403': *27 '401': *23 - '400': *657 + '400': *659 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107171,17 +107083,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 responses: '200': description: Response content: application/json: - schema: *225 + schema: *231 examples: - default: *673 + default: *675 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -107202,9 +107114,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 responses: '204': description: Response @@ -107236,9 +107148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 - name: token description: package token schema: @@ -107270,9 +107182,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: - - *227 - - *228 - - *57 + - *233 + - *234 + - *61 responses: '200': description: Response @@ -107280,7 +107192,7 @@ paths: application/json: schema: type: array - items: *229 + items: *235 examples: default: value: @@ -107338,16 +107250,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *227 - - *228 - - *230 - - *57 + - *233 + - *234 + - *236 + - *61 responses: '200': description: Response content: application/json: - schema: *229 + schema: *235 examples: default: value: @@ -107382,10 +107294,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *227 - - *228 - - *57 - - *230 + - *233 + - *234 + - *61 + - *236 responses: '204': description: Response @@ -107417,10 +107329,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *227 - - *228 - - *57 - - *230 + - *233 + - *234 + - *61 + - *236 responses: '204': description: Response @@ -107444,15 +107356,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - - *57 + - *61 - name: q description: Limit results to projects of the specified type. in: query required: false schema: type: string - - *38 - - *39 + - *43 + - *44 - *17 responses: '200': @@ -107461,11 +107373,11 @@ paths: application/json: schema: type: array - items: *241 + items: *247 examples: - default: *242 + default: *248 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107485,18 +107397,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-project-for-user parameters: - - *243 - - *57 + - *249 + - *61 responses: '200': description: Response content: application/json: - schema: *241 + schema: *247 examples: - default: *242 + default: *248 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107516,11 +107428,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user parameters: - - *243 - - *57 + - *249 + - *61 - *17 - - *38 - - *39 + - *43 + - *44 responses: '200': description: Response @@ -107528,11 +107440,11 @@ paths: application/json: schema: type: array - items: *246 + items: *252 examples: - default: *674 + default: *676 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107541,6 +107453,116 @@ paths: enabledForGitHubApps: true category: projects subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - *61 + - *249 + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: *677 + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: *678 + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: *679 + iteration_field: *680 + responses: + '201': + description: Response + content: + application/json: + schema: *252 + examples: + text_field: *681 + number_field: *682 + date_field: *683 + single_select_field: *684 + iteration_field: *685 + '304': *35 + '403': *27 + '401': *23 + '422': *15 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields "/users/{username}/projectsV2/{project_number}/fields/{field_id}": get: summary: Get project field for user @@ -107552,19 +107574,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/fields#get-project-field-for-user parameters: - - *243 - - *675 - - *57 + - *249 + - *686 + - *61 responses: '200': description: Response content: application/json: - schema: *246 + schema: *252 examples: - default: *676 + default: *687 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107585,10 +107607,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project parameters: - - *243 - - *57 - - *38 - - *39 + - *249 + - *61 + - *43 + - *44 - *17 - 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) @@ -107618,11 +107640,11 @@ paths: application/json: schema: type: array - items: *250 + items: *256 examples: - default: *251 + default: *257 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107641,8 +107663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project parameters: - - *57 - - *243 + - *61 + - *249 requestBody: required: true description: Details of the item to add to the project. @@ -107679,10 +107701,10 @@ paths: description: Response content: application/json: - schema: *248 + schema: *254 examples: - issue: *249 - pull_request: *249 + issue: *255 + pull_request: *255 '304': *35 '403': *27 '401': *23 @@ -107702,9 +107724,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project parameters: - - *243 - - *57 - - *252 + - *249 + - *61 + - *258 - name: fields description: |- Limit results to specific fields, by their IDs. If not specified, the title field will be returned. @@ -107724,11 +107746,11 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - default: *251 + default: *257 headers: - Link: *52 + Link: *56 '304': *35 '403': *27 '401': *23 @@ -107747,9 +107769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#update-project-item-for-user parameters: - - *243 - - *57 - - *252 + - *249 + - *61 + - *258 requestBody: required: true description: Field updates to apply to the project item. Only text, number, @@ -107822,13 +107844,13 @@ paths: description: Response content: application/json: - schema: *250 + schema: *256 examples: - text_field: *251 - number_field: *251 - date_field: *251 - single_select_field: *251 - iteration_field: *251 + text_field: *257 + number_field: *257 + date_field: *257 + single_select_field: *257 + iteration_field: *257 '401': *23 '403': *27 '404': *6 @@ -107848,9 +107870,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/items#delete-project-item-for-user parameters: - - *243 - - *57 - - *252 + - *249 + - *61 + - *258 responses: '204': description: Response @@ -107877,7 +107899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107887,7 +107909,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -107952,7 +107974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -107962,7 +107984,7 @@ paths: application/json: schema: type: array - items: *89 + items: *93 examples: default: value: @@ -108025,7 +108047,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *57 + - *61 - name: type description: Limit results to repositories of the specified type. in: query @@ -108068,11 +108090,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108092,12 +108114,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - - *57 - - *99 - - *101 - - *100 - - *677 - - *102 + - *61 + - *105 + - *107 + - *106 + - *688 + - *108 responses: '200': description: Response when getting a billing premium request usage report @@ -108204,8 +108226,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108225,10 +108247,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - - *57 - - *99 - - *678 - - *100 + - *61 + - *105 + - *689 + - *106 responses: '200': description: Response when getting a billing usage report @@ -108298,8 +108320,8 @@ paths: repositoryName: user/example '400': *14 '403': *27 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108322,13 +108344,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - - *57 - - *99 - - *101 - - *100 - - *679 - - *102 - - *680 + - *61 + - *105 + - *107 + - *106 + - *690 + - *108 + - *691 responses: '200': description: Response when getting a billing usage summary @@ -108433,8 +108455,8 @@ paths: '400': *14 '403': *27 '404': *6 - '500': *96 - '503': *97 + '500': *102 + '503': *103 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108452,7 +108474,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -108462,11 +108484,11 @@ paths: application/json: schema: type: array - items: *660 + items: *662 examples: - default: *661 + default: *663 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108484,7 +108506,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -108494,11 +108516,11 @@ paths: application/json: schema: type: array - items: *662 + items: *664 examples: - default: *681 + default: *692 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108520,9 +108542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *57 - - *682 - - *46 + - *61 + - *693 + - *50 - *17 - *19 responses: @@ -108533,13 +108555,13 @@ paths: schema: anyOf: - type: array - items: *683 + items: *694 - type: array - items: *64 + items: *68 examples: - default-response: *665 + default-response: *667 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108556,7 +108578,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *57 + - *61 - *17 - *19 responses: @@ -108566,11 +108588,11 @@ paths: application/json: schema: type: array - items: *136 + items: *142 examples: - default: *231 + default: *237 headers: - Link: *52 + Link: *56 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -108697,7 +108719,7 @@ webhooks: type: string enum: - disabled - enterprise: &684 + enterprise: &695 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -108766,7 +108788,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &685 + installation: &696 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -108787,7 +108809,7 @@ webhooks: required: - id - node_id - organization: &686 + organization: &697 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -108860,7 +108882,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &687 + repository: &698 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -108889,7 +108911,7 @@ webhooks: license: anyOf: - type: 'null' - - *79 + - *83 organization: anyOf: - type: 'null' @@ -109773,10 +109795,10 @@ webhooks: type: string enum: - enabled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -109852,11 +109874,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: &688 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + rule: &699 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) @@ -110079,11 +110101,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + rule: *699 sender: *4 required: - action @@ -110271,11 +110293,11 @@ webhooks: - everyone required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - rule: *688 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + rule: *699 sender: *4 required: - action @@ -110359,7 +110381,7 @@ webhooks: type: string enum: - completed - check_run: &690 + check_run: &701 title: CheckRun description: A check performed on the code of a given code change type: object @@ -110424,8 +110446,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *390 - repository: *136 + items: *394 + repository: *142 status: type: string enum: @@ -110469,7 +110491,7 @@ webhooks: - examples: - neutral - deployment: *689 + deployment: *700 details_url: type: string examples: @@ -110529,7 +110551,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *390 + items: *394 started_at: type: string format: date-time @@ -110567,10 +110589,10 @@ webhooks: - output - app - pull_requests - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 sender: *4 required: - check_run @@ -110963,11 +110985,11 @@ webhooks: type: string enum: - created - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *701 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 sender: *4 required: - check_run @@ -111363,11 +111385,11 @@ webhooks: type: string enum: - requested_action - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *701 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 requested_action: description: The action requested by the user. type: object @@ -111772,11 +111794,11 @@ webhooks: type: string enum: - rerequested - check_run: *690 - installation: *685 - enterprise: *684 - organization: *686 - repository: *687 + check_run: *701 + installation: *696 + enterprise: *695 + organization: *697 + repository: *698 sender: *4 required: - check_run @@ -112768,10 +112790,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -113052,6 +113074,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -113471,10 +113498,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -113750,6 +113777,11 @@ webhooks: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write attestations: type: string enum: @@ -114168,10 +114200,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -114340,7 +114372,7 @@ webhooks: required: - login - id - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114492,20 +114524,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &691 + commit_oid: &702 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: *684 - installation: *685 - organization: *686 - ref: &692 + enterprise: *695 + installation: *696 + organization: *697 + ref: &703 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: *687 + repository: *698 sender: *4 required: - action @@ -114672,7 +114704,7 @@ webhooks: required: - login - id - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -114913,12 +114945,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -115016,7 +115048,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115201,12 +115233,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -115375,7 +115407,7 @@ webhooks: required: - login - id - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: The reason for dismissing or closing the alert. type: @@ -115552,12 +115584,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -115660,7 +115692,7 @@ webhooks: type: - object - 'null' - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -115840,9 +115872,9 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -115850,7 +115882,7 @@ webhooks: type: - string - 'null' - repository: *687 + repository: *698 sender: *4 required: - action @@ -115949,7 +115981,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *405 + dismissed_comment: *409 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -116096,12 +116128,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *691 - enterprise: *684 - installation: *685 - organization: *686 - ref: *692 - repository: *687 + commit_oid: *702 + enterprise: *695 + installation: *696 + organization: *697 + ref: *703 + repository: *698 sender: *4 required: - action @@ -116363,10 +116395,10 @@ webhooks: - updated_at - author_association - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -116447,18 +116479,18 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *686 - pusher_type: &693 + organization: *697 + pusher_type: &704 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &694 + ref: &705 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -116468,7 +116500,7 @@ webhooks: enum: - tag - branch - repository: *687 + repository: *698 sender: *4 required: - ref @@ -116550,10 +116582,10 @@ webhooks: type: string enum: - created - definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + definition: *259 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116638,9 +116670,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116717,10 +116749,10 @@ webhooks: type: string enum: - promote_to_enterprise - definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + definition: *259 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116797,10 +116829,10 @@ webhooks: type: string enum: - updated - definition: *253 - enterprise: *684 - installation: *685 - organization: *686 + definition: *259 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -116877,19 +116909,19 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - repository: *687 - organization: *686 + enterprise: *695 + installation: *696 + repository: *698 + organization: *697 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *95 + items: *101 old_property_values: type: array description: The old custom property values for the repository. - items: *95 + items: *101 required: - action - repository @@ -116965,18 +116997,18 @@ webhooks: title: delete event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - pusher_type: *693 - ref: *694 + enterprise: *695 + installation: *696 + organization: *697 + pusher_type: *704 + ref: *705 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *687 + repository: *698 sender: *4 required: - ref @@ -117060,11 +117092,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117148,11 +117180,11 @@ webhooks: type: string enum: - auto_reopened - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117236,11 +117268,11 @@ webhooks: type: string enum: - created - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117322,11 +117354,11 @@ webhooks: type: string enum: - dismissed - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117408,11 +117440,11 @@ webhooks: type: string enum: - fixed - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117495,11 +117527,11 @@ webhooks: type: string enum: - reintroduced - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117581,11 +117613,11 @@ webhooks: type: string enum: - reopened - alert: *457 - installation: *685 - organization: *686 - enterprise: *684 - repository: *687 + alert: *461 + installation: *696 + organization: *697 + enterprise: *695 + repository: *698 sender: *4 required: - action @@ -117662,9 +117694,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - key: &695 + enterprise: *695 + installation: *696 + key: &706 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -117702,8 +117734,8 @@ webhooks: - verified - created_at - read_only - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -117780,11 +117812,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - key: *695 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + key: *706 + organization: *697 + repository: *698 sender: *4 required: - action @@ -118356,12 +118388,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: &699 + workflow: &710 title: Workflow type: - object @@ -119099,13 +119131,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *463 + deployment: *467 pull_requests: type: array - items: *547 - repository: *687 - organization: *686 - installation: *685 + items: *551 + repository: *698 + organization: *697 + installation: *696 sender: *4 responses: '200': @@ -119176,7 +119208,7 @@ webhooks: type: string enum: - approved - approver: &696 + approver: &707 type: object properties: avatar_url: @@ -119219,11 +119251,11 @@ webhooks: type: string comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: &697 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + reviewers: &708 type: array items: type: object @@ -119304,7 +119336,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &698 + workflow_job_run: &709 type: object properties: conclusion: @@ -120050,18 +120082,18 @@ webhooks: type: string enum: - rejected - approver: *696 + approver: *707 comment: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - reviewers: *697 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + reviewers: *708 sender: *4 since: type: string - workflow_job_run: *698 + workflow_job_run: *709 workflow_job_runs: type: array items: @@ -120778,13 +120810,13 @@ webhooks: type: string enum: - requested - enterprise: *684 + enterprise: *695 environment: type: string - installation: *685 - organization: *686 - repository: *687 - requestor: &704 + installation: *696 + organization: *697 + repository: *698 + requestor: &715 title: User type: - object @@ -122727,12 +122759,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - workflow: *699 + workflow: *710 workflow_run: title: Deployment Workflow Run type: @@ -123423,7 +123455,7 @@ webhooks: type: string enum: - answered - answer: &702 + answer: &713 type: object properties: author_association: @@ -123583,7 +123615,7 @@ webhooks: - created_at - updated_at - body - discussion: &700 + discussion: &711 title: Discussion description: A Discussion in a repository. type: object @@ -123879,7 +123911,7 @@ webhooks: - id labels: type: array - items: *510 + items: *514 required: - repository_url - category @@ -123901,10 +123933,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124031,11 +124063,11 @@ webhooks: - from required: - category - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124118,11 +124150,11 @@ webhooks: type: string enum: - closed - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124204,7 +124236,7 @@ webhooks: type: string enum: - created - comment: &701 + comment: &712 type: object properties: author_association: @@ -124364,11 +124396,11 @@ webhooks: - updated_at - body - reactions - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124451,12 +124483,12 @@ webhooks: type: string enum: - deleted - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *712 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124551,12 +124583,12 @@ webhooks: - from required: - body - comment: *701 - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + comment: *712 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124640,11 +124672,11 @@ webhooks: type: string enum: - created - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124726,11 +124758,11 @@ webhooks: type: string enum: - deleted - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124830,11 +124862,11 @@ webhooks: type: string required: - from - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -124916,10 +124948,10 @@ webhooks: type: string enum: - labeled - discussion: *700 - enterprise: *684 - installation: *685 - label: &703 + discussion: *711 + enterprise: *695 + installation: *696 + label: &714 title: Label type: object properties: @@ -124952,8 +124984,8 @@ webhooks: - color - default - description - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125036,11 +125068,11 @@ webhooks: type: string enum: - locked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125122,11 +125154,11 @@ webhooks: type: string enum: - pinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125208,11 +125240,11 @@ webhooks: type: string enum: - reopened - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125297,16 +125329,16 @@ webhooks: changes: type: object properties: - new_discussion: *700 - new_repository: *687 + new_discussion: *711 + new_repository: *698 required: - new_discussion - new_repository - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125389,10 +125421,10 @@ webhooks: type: string enum: - unanswered - discussion: *700 - old_answer: *702 - organization: *686 - repository: *687 + discussion: *711 + old_answer: *713 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125474,12 +125506,12 @@ webhooks: type: string enum: - unlabeled - discussion: *700 - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125562,11 +125594,11 @@ webhooks: type: string enum: - unlocked - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125648,11 +125680,11 @@ webhooks: type: string enum: - unpinned - discussion: *700 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + discussion: *711 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -125725,7 +125757,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *684 + enterprise: *695 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -126403,9 +126435,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - forkee @@ -126551,9 +126583,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pages: description: The pages that were updated. type: array @@ -126591,7 +126623,7 @@ webhooks: - action - sha - html_url - repository: *687 + repository: *698 sender: *4 required: - pages @@ -126667,10 +126699,10 @@ webhooks: type: string enum: - created - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: &705 + organization: *697 + repositories: &716 description: An array of repository objects that the installation can access. type: array @@ -126696,8 +126728,8 @@ webhooks: - name - full_name - private - repository: *687 - requester: *704 + repository: *698 + requester: *715 sender: *4 required: - action @@ -126772,11 +126804,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -126853,11 +126885,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -126934,10 +126966,10 @@ webhooks: type: string enum: - added - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories_added: &706 + organization: *697 + repositories_added: &717 description: An array of repository objects, which were added to the installation. type: array @@ -126983,15 +127015,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *687 - repository_selection: &707 + repository: *698 + repository_selection: &718 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *704 + requester: *715 sender: *4 required: - action @@ -127070,10 +127102,10 @@ webhooks: type: string enum: - removed - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories_added: *706 + organization: *697 + repositories_added: *717 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -127100,9 +127132,9 @@ webhooks: - name - full_name - private - repository: *687 - repository_selection: *707 - requester: *704 + repository: *698 + repository_selection: *718 + requester: *715 sender: *4 required: - action @@ -127181,11 +127213,11 @@ webhooks: type: string enum: - suspend - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -127367,10 +127399,10 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 target_type: type: string @@ -127449,11 +127481,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *684 + enterprise: *695 installation: *20 - organization: *686 - repositories: *705 - repository: *687 + organization: *697 + repositories: *716 + repository: *698 requester: type: - 'null' @@ -127701,8 +127733,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -128519,8 +128551,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 state: description: State of the issue; either 'open' or 'closed' type: string @@ -128537,7 +128569,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -128881,8 +128913,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -128962,7 +128994,7 @@ webhooks: type: string enum: - deleted - comment: &708 + comment: &719 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -129129,8 +129161,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -129943,8 +129975,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 state: description: State of the issue; either 'open' or 'closed' type: string @@ -129961,7 +129993,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -130307,8 +130339,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -130388,7 +130420,7 @@ webhooks: type: string enum: - edited - changes: &732 + changes: &743 description: The changes to the comment. type: object properties: @@ -130400,9 +130432,9 @@ webhooks: type: string required: - from - comment: *708 - enterprise: *684 - installation: *685 + comment: *719 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -131218,8 +131250,8 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 state: description: State of the issue; either 'open' or 'closed' type: string @@ -131236,7 +131268,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -131580,8 +131612,8 @@ webhooks: - state - locked - assignee - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131665,15 +131697,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 + blocked_issue: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + blocking_issue_repo: *68 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131761,15 +131793,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 + blocked_issue: *82 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - blocking_issue_repo: *64 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + blocking_issue_repo: *68 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131856,15 +131888,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 - blocked_issue_repo: *64 + blocked_issue: *82 + blocked_issue_repo: *68 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -131952,15 +131984,15 @@ webhooks: blocked_issue_id: description: The ID of the blocked issue. type: number - blocked_issue: *78 - blocked_issue_repo: *64 + blocked_issue: *82 + blocked_issue_repo: *68 blocking_issue_id: description: The ID of the blocking issue. type: number - blocking_issue: *78 - installation: *685 - organization: *686 - repository: *687 + blocking_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -132045,10 +132077,10 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - issue: &711 + assignee: *715 + enterprise: *695 + installation: *696 + issue: &722 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -132860,11 +132892,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -132881,7 +132913,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -132984,8 +133016,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -133065,8 +133097,8 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133883,11 +133915,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -133904,7 +133936,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -134150,8 +134182,8 @@ webhooks: required: - state - closed_at - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -134230,8 +134262,8 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -135039,11 +135071,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -135060,7 +135092,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -135162,8 +135194,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -135242,8 +135274,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136074,11 +136106,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -136095,7 +136127,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -136176,7 +136208,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &709 + milestone: &720 title: Milestone description: A collection of related issues and pull requests. type: object @@ -136319,8 +136351,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -136419,8 +136451,8 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -137232,11 +137264,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -137250,7 +137282,7 @@ webhooks: timeline_url: type: string format: uri - type: *208 + type: *214 title: description: Title of the issue type: string @@ -137356,9 +137388,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -137438,8 +137470,8 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -138250,11 +138282,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -138268,7 +138300,7 @@ webhooks: timeline_url: type: string format: uri - type: *208 + type: *214 title: description: Title of the issue type: string @@ -138374,9 +138406,9 @@ webhooks: - active_lock_reason - body - reactions - label: *703 - organization: *686 - repository: *687 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -138456,8 +138488,8 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -139293,11 +139325,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -139311,7 +139343,7 @@ webhooks: timeline_url: type: string format: uri - type: *208 + type: *214 title: description: Title of the issue type: string @@ -139394,8 +139426,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -139474,8 +139506,8 @@ webhooks: type: string enum: - milestoned - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -140305,11 +140337,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -140326,7 +140358,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -140406,9 +140438,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *709 - organization: *686 - repository: *687 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -141300,11 +141332,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -141400,7 +141432,7 @@ webhooks: required: - login - id - type: *208 + type: *214 required: - id - number @@ -141881,8 +141913,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -142694,11 +142726,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -142715,7 +142747,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -142817,8 +142849,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -142898,9 +142930,9 @@ webhooks: type: string enum: - pinned - enterprise: *684 - installation: *685 - issue: &710 + enterprise: *695 + installation: *696 + issue: &721 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -143706,11 +143738,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -143727,7 +143759,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -143829,8 +143861,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -143909,8 +143941,8 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -144744,11 +144776,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -144845,9 +144877,9 @@ webhooks: format: uri user_view_type: type: string - type: *208 - organization: *686 - repository: *687 + type: *214 + organization: *697 + repository: *698 sender: *4 required: - action @@ -145736,11 +145768,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -145757,7 +145789,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -146339,11 +146371,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *721 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146423,12 +146455,12 @@ webhooks: type: string enum: - typed - enterprise: *684 - installation: *685 - issue: *711 - type: *208 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + type: *214 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146509,7 +146541,7 @@ webhooks: type: string enum: - unassigned - assignee: &735 + assignee: &746 title: User type: - object @@ -146581,11 +146613,11 @@ webhooks: required: - login - id - enterprise: *684 - installation: *685 - issue: *711 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146664,12 +146696,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - issue: *711 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -146749,8 +146781,8 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -147584,11 +147616,11 @@ webhooks: repository_url: type: string format: uri - sub_issues_summary: *625 - issue_dependencies_summary: *626 + sub_issues_summary: *629 + issue_dependencies_summary: *630 issue_field_values: type: array - items: *627 + items: *631 state: description: State of the issue; either 'open' or 'closed' type: string @@ -147605,7 +147637,7 @@ webhooks: title: description: Title of the issue type: string - type: *208 + type: *214 updated_at: type: string format: date-time @@ -147685,8 +147717,8 @@ webhooks: format: uri user_view_type: type: string - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -147766,11 +147798,11 @@ webhooks: type: string enum: - unpinned - enterprise: *684 - installation: *685 - issue: *710 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *721 + organization: *697 + repository: *698 sender: *4 required: - action @@ -147849,12 +147881,12 @@ webhooks: type: string enum: - untyped - enterprise: *684 - installation: *685 - issue: *711 - type: *208 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + issue: *722 + type: *214 + organization: *697 + repository: *698 sender: *4 required: - action @@ -147934,11 +147966,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -148016,11 +148048,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -148130,11 +148162,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - label: *703 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + label: *714 + organization: *697 + repository: *698 sender: *4 required: - action @@ -148216,9 +148248,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: &712 + enterprise: *695 + installation: *696 + marketplace_purchase: &723 title: Marketplace Purchase type: object required: @@ -148306,8 +148338,8 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: &713 + organization: *697 + previous_marketplace_purchase: &724 title: Marketplace Purchase type: object properties: @@ -148391,7 +148423,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *698 sender: *4 required: - action @@ -148471,10 +148503,10 @@ webhooks: - changed effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *695 + installation: *696 + marketplace_purchase: *723 + organization: *697 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148562,7 +148594,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *698 sender: *4 required: - action @@ -148644,10 +148676,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 + enterprise: *695 + installation: *696 + marketplace_purchase: *723 + organization: *697 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -148733,7 +148765,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *687 + repository: *698 sender: *4 required: - action @@ -148814,8 +148846,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 marketplace_purchase: title: Marketplace Purchase type: object @@ -148901,9 +148933,9 @@ webhooks: type: integer unit_count: type: integer - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + organization: *697 + previous_marketplace_purchase: *724 + repository: *698 sender: *4 required: - action @@ -148983,12 +149015,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *684 - installation: *685 - marketplace_purchase: *712 - organization: *686 - previous_marketplace_purchase: *713 - repository: *687 + enterprise: *695 + installation: *696 + marketplace_purchase: *723 + organization: *697 + previous_marketplace_purchase: *724 + repository: *698 sender: *4 required: - action @@ -149090,11 +149122,11 @@ webhooks: type: string required: - to - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149196,11 +149228,11 @@ webhooks: type: - string - 'null' - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149279,11 +149311,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149361,11 +149393,11 @@ webhooks: type: string enum: - added - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149443,7 +149475,7 @@ webhooks: required: - login - id - team: &714 + team: &725 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -149673,11 +149705,11 @@ webhooks: type: string enum: - removed - enterprise: *684 - installation: *685 - member: *704 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + member: *715 + organization: *697 + repository: *698 scope: description: The scope of the membership. Currently, can only be `team`. @@ -149756,7 +149788,7 @@ webhooks: required: - login - id - team: *714 + team: *725 required: - action - scope @@ -149838,8 +149870,8 @@ webhooks: type: string enum: - checks_requested - installation: *685 - merge_group: &715 + installation: *696 + merge_group: &726 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -149858,15 +149890,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *394 + head_commit: *398 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -149952,10 +149984,10 @@ webhooks: - merged - invalidated - dequeued - installation: *685 - merge_group: *715 - organization: *686 - repository: *687 + installation: *696 + merge_group: *726 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150028,7 +150060,7 @@ webhooks: type: string enum: - deleted - enterprise: *684 + enterprise: *695 hook: description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -150137,12 +150169,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *685 - organization: *686 + installation: *696 + organization: *697 repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -150222,11 +150254,11 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150305,9 +150337,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - milestone: &716 + enterprise: *695 + installation: *696 + milestone: &727 title: Milestone description: A collection of related issues and pull requests. type: object @@ -150449,8 +150481,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150529,11 +150561,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150643,11 +150675,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - milestone: *709 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *720 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150727,11 +150759,11 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - milestone: *716 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + milestone: *727 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150810,11 +150842,11 @@ webhooks: type: string enum: - blocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *715 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150893,11 +150925,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *704 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + blocked_user: *715 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -150976,9 +151008,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - membership: &717 + enterprise: *695 + installation: *696 + membership: &728 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -151088,8 +151120,8 @@ webhooks: - role - organization_url - user - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151167,11 +151199,11 @@ webhooks: type: string enum: - member_added - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + membership: *728 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151250,8 +151282,8 @@ webhooks: type: string enum: - member_invited - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -151373,10 +151405,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 - user: *704 + user: *715 required: - action - invitation @@ -151454,11 +151486,11 @@ webhooks: type: string enum: - member_removed - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + membership: *728 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151545,11 +151577,11 @@ webhooks: properties: from: type: string - enterprise: *684 - installation: *685 - membership: *717 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + membership: *728 + organization: *697 + repository: *698 sender: *4 required: - action @@ -151625,9 +151657,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 package: description: Information about the package. type: object @@ -152150,7 +152182,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &718 + items: &729 title: Ruby Gems metadata type: object properties: @@ -152247,7 +152279,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -152323,9 +152355,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 package: description: Information about the package. type: object @@ -152687,7 +152719,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *729 source_url: type: string format: uri @@ -152758,7 +152790,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -152939,12 +152971,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *684 + enterprise: *695 id: type: integer - installation: *685 - organization: *686 - repository: *687 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - id @@ -153021,7 +153053,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &719 + personal_access_token_request: &730 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -153171,10 +153203,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *684 - organization: *686 + enterprise: *695 + organization: *697 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153251,11 +153283,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *730 + enterprise: *695 + organization: *697 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153331,11 +153363,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *719 - enterprise: *684 - organization: *686 + personal_access_token_request: *730 + enterprise: *695 + organization: *697 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153410,11 +153442,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *719 - organization: *686 - enterprise: *684 + personal_access_token_request: *730 + organization: *697 + enterprise: *695 sender: *4 - installation: *685 + installation: *696 required: - action - personal_access_token_request @@ -153519,7 +153551,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *720 + last_response: *731 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -153551,8 +153583,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 zen: description: Random string of GitHub zen. @@ -153797,10 +153829,10 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: &721 + enterprise: *695 + installation: *696 + organization: *697 + project_card: &732 title: Project Card type: object properties: @@ -153923,7 +153955,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *698 sender: *4 required: - action @@ -154004,11 +154036,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_card: *732 + repository: *698 sender: *4 required: - action @@ -154088,9 +154120,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 project_card: title: Project Card type: object @@ -154220,7 +154252,7 @@ webhooks: repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -154314,11 +154346,11 @@ webhooks: - from required: - note - enterprise: *684 - installation: *685 - organization: *686 - project_card: *721 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_card: *732 + repository: *698 sender: *4 required: - action @@ -154412,9 +154444,9 @@ webhooks: - from required: - column_id - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 project_card: allOf: - title: Project Card @@ -154611,7 +154643,7 @@ webhooks: type: string required: - after_id - repository: *687 + repository: *698 sender: *4 required: - action @@ -154691,10 +154723,10 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - organization: *686 - project: &723 + enterprise: *695 + installation: *696 + organization: *697 + project: &734 title: Project type: object properties: @@ -154821,7 +154853,7 @@ webhooks: - creator - created_at - updated_at - repository: *687 + repository: *698 sender: *4 required: - action @@ -154901,10 +154933,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project_column: &722 + enterprise: *695 + installation: *696 + organization: *697 + project_column: &733 title: Project Column type: object properties: @@ -154944,7 +154976,7 @@ webhooks: - name - created_at - updated_at - repository: *687 + repository: *698 sender: *4 required: - action @@ -155023,14 +155055,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 + enterprise: *695 + installation: *696 + organization: *697 + project_column: *733 repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -155119,11 +155151,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_column: *733 + repository: *698 sender: *4 required: - action @@ -155203,11 +155235,11 @@ webhooks: type: string enum: - moved - enterprise: *684 - installation: *685 - organization: *686 - project_column: *722 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project_column: *733 + repository: *698 sender: *4 required: - action @@ -155287,11 +155319,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 + repository: *698 sender: *4 required: - action @@ -155371,14 +155403,14 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - project: *723 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 repository: anyOf: - type: 'null' - - *687 + - *698 sender: *4 required: - action @@ -155479,11 +155511,11 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 + repository: *698 sender: *4 required: - action @@ -155562,11 +155594,11 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - organization: *686 - project: *723 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + project: *734 + repository: *698 sender: *4 required: - action @@ -155647,9 +155679,9 @@ webhooks: type: string enum: - closed - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -155730,9 +155762,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -155813,9 +155845,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -155936,9 +155968,9 @@ webhooks: type: string to: type: string - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -156021,7 +156053,7 @@ webhooks: type: string enum: - archived - changes: &727 + changes: &738 type: object properties: archived_at: @@ -156037,9 +156069,9 @@ webhooks: - string - 'null' format: date-time - installation: *685 - organization: *686 - projects_v2_item: &724 + installation: *696 + organization: *697 + projects_v2_item: &735 title: Projects v2 Item description: An item belonging to a project type: object @@ -156057,7 +156089,7 @@ webhooks: type: string description: The node ID of the content represented by this item. - content_type: *247 + content_type: *253 creator: *4 created_at: type: string @@ -156179,9 +156211,9 @@ webhooks: - 'null' to: type: string - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156263,9 +156295,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156346,9 +156378,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156453,7 +156485,7 @@ webhooks: oneOf: - type: string - type: integer - - &725 + - &736 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -156477,7 +156509,7 @@ webhooks: required: - id - name - - &726 + - &737 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -156517,8 +156549,8 @@ webhooks: oneOf: - type: string - type: integer - - *725 - - *726 + - *736 + - *737 type: - 'null' - string @@ -156541,9 +156573,9 @@ webhooks: - 'null' required: - body - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156640,9 +156672,9 @@ webhooks: type: - string - 'null' - installation: *685 - organization: *686 - projects_v2_item: *724 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156725,10 +156757,10 @@ webhooks: type: string enum: - restored - changes: *727 - installation: *685 - organization: *686 - projects_v2_item: *724 + changes: *738 + installation: *696 + organization: *697 + projects_v2_item: *735 sender: *4 required: - action @@ -156810,9 +156842,9 @@ webhooks: type: string enum: - reopened - installation: *685 - organization: *686 - projects_v2: *241 + installation: *696 + organization: *697 + projects_v2: *247 sender: *4 required: - action @@ -156893,9 +156925,9 @@ webhooks: type: string enum: - created - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *696 + organization: *697 + projects_v2_status_update: *739 sender: *4 required: - action @@ -156976,9 +157008,9 @@ webhooks: type: string enum: - deleted - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *696 + organization: *697 + projects_v2_status_update: *739 sender: *4 required: - action @@ -157124,9 +157156,9 @@ webhooks: - string - 'null' format: date - installation: *685 - organization: *686 - projects_v2_status_update: *728 + installation: *696 + organization: *697 + projects_v2_status_update: *739 sender: *4 required: - action @@ -157197,10 +157229,10 @@ webhooks: title: public event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - repository @@ -157277,13 +157309,13 @@ webhooks: type: string enum: - assigned - assignee: *704 - enterprise: *684 - installation: *685 - number: &729 + assignee: *715 + enterprise: *695 + installation: *696 + number: &740 description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -159632,7 +159664,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -159714,11 +159746,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -162060,7 +162092,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *698 sender: *4 required: - action @@ -162142,11 +162174,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -164488,7 +164520,7 @@ webhooks: - draft reason: type: string - repository: *687 + repository: *698 sender: *4 required: - action @@ -164570,13 +164602,13 @@ webhooks: type: string enum: - closed - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: &730 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: &741 allOf: - - *547 + - *551 - type: object properties: allow_auto_merge: @@ -164638,7 +164670,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *687 + repository: *698 sender: *4 required: - action @@ -164719,12 +164751,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -164804,11 +164836,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *684 - milestone: *244 - number: *729 - organization: *686 - pull_request: &731 + enterprise: *695 + milestone: *250 + number: *740 + organization: *697 + pull_request: &742 title: Pull Request type: object properties: @@ -167135,7 +167167,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -167214,11 +167246,11 @@ webhooks: type: string enum: - dequeued - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -169564,7 +169596,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *687 + repository: *698 sender: *4 required: - action @@ -169688,12 +169720,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -169773,11 +169805,11 @@ webhooks: type: string enum: - enqueued - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -172108,7 +172140,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -172188,11 +172220,11 @@ webhooks: type: string enum: - labeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + label: *714 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -174540,7 +174572,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -174621,10 +174653,10 @@ webhooks: type: string enum: - locked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -176970,7 +177002,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -177050,12 +177082,12 @@ webhooks: type: string enum: - milestoned - enterprise: *684 - milestone: *244 - number: *729 - organization: *686 - pull_request: *731 - repository: *687 + enterprise: *695 + milestone: *250 + number: *740 + organization: *697 + pull_request: *742 + repository: *698 sender: *4 required: - action @@ -177134,12 +177166,12 @@ webhooks: type: string enum: - opened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -177220,12 +177252,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -177305,12 +177337,12 @@ webhooks: type: string enum: - reopened - enterprise: *684 - installation: *685 - number: *729 - organization: *686 - pull_request: *730 - repository: *687 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 + pull_request: *741 + repository: *698 sender: *4 required: - action @@ -177685,9 +177717,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: type: object properties: @@ -179917,7 +179949,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *698 sender: *4 required: - action @@ -179997,7 +180029,7 @@ webhooks: type: string enum: - deleted - comment: &733 + comment: &744 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -180290,9 +180322,9 @@ webhooks: - start_side - side - reactions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: type: object properties: @@ -182510,7 +182542,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *698 sender: *4 required: - action @@ -182590,11 +182622,11 @@ webhooks: type: string enum: - edited - changes: *732 - comment: *733 - enterprise: *684 - installation: *685 - organization: *686 + changes: *743 + comment: *744 + enterprise: *695 + installation: *696 + organization: *697 pull_request: type: object properties: @@ -184815,7 +184847,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *687 + repository: *698 sender: *4 required: - action @@ -184896,9 +184928,9 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -187131,7 +187163,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *698 review: description: The review that was affected. type: object @@ -187382,9 +187414,9 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -189498,8 +189530,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: &734 + repository: *698 + review: &745 description: The review that was affected. type: object properties: @@ -189737,12 +189769,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -192089,7 +192121,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_reviewer: title: User type: @@ -192175,12 +192207,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -194534,7 +194566,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_team: title: Team description: Groups of organization members that gives permissions @@ -194729,12 +194761,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -197083,7 +197115,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_reviewer: title: User type: @@ -197170,12 +197202,12 @@ webhooks: type: string enum: - review_requested - enterprise: *684 - installation: *685 + enterprise: *695 + installation: *696 number: description: The pull request number. type: integer - organization: *686 + organization: *697 pull_request: title: Pull Request type: object @@ -199515,7 +199547,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 requested_team: title: Team description: Groups of organization members that gives permissions @@ -199699,9 +199731,9 @@ webhooks: type: string enum: - submitted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -201937,8 +201969,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 - review: *734 + repository: *698 + review: *745 sender: *4 required: - action @@ -202018,9 +202050,9 @@ webhooks: type: string enum: - resolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -204151,7 +204183,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *698 sender: *4 thread: type: object @@ -204548,9 +204580,9 @@ webhooks: type: string enum: - unresolved - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 pull_request: title: Simple Pull Request type: object @@ -206664,7 +206696,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *687 + repository: *698 sender: *4 thread: type: object @@ -207063,10 +207095,10 @@ webhooks: type: string before: type: string - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -209401,7 +209433,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -209483,11 +209515,11 @@ webhooks: type: string enum: - unassigned - assignee: *735 - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + assignee: *746 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -211837,7 +211869,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -211916,11 +211948,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *684 - installation: *685 - label: *703 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + label: *714 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -214259,7 +214291,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -214340,10 +214372,10 @@ webhooks: type: string enum: - unlocked - enterprise: *684 - installation: *685 - number: *729 - organization: *686 + enterprise: *695 + installation: *696 + number: *740 + organization: *697 pull_request: title: Pull Request type: object @@ -216672,7 +216704,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *687 + repository: *698 sender: *4 required: - action @@ -216875,7 +216907,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *684 + enterprise: *695 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -216970,8 +217002,8 @@ webhooks: - url - author - committer - installation: *685 - organization: *686 + installation: *696 + organization: *697 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -217559,9 +217591,9 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 registry_package: type: object properties: @@ -218038,7 +218070,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *718 + items: *729 summary: type: string tag_name: @@ -218094,7 +218126,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -218172,9 +218204,9 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 registry_package: type: object properties: @@ -218486,7 +218518,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *718 + items: *729 summary: type: string tag_name: @@ -218536,7 +218568,7 @@ webhooks: - owner - package_version - registry - repository: *687 + repository: *698 sender: *4 required: - action @@ -218613,10 +218645,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - release: &736 + enterprise: *695 + installation: *696 + organization: *697 + release: &747 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -218947,7 +218979,7 @@ webhooks: - updated_at - zipball_url - body - repository: *687 + repository: *698 sender: *4 required: - action @@ -219024,11 +219056,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *747 + repository: *698 sender: *4 required: - action @@ -219145,11 +219177,11 @@ webhooks: type: boolean required: - to - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *747 + repository: *698 sender: *4 required: - action @@ -219227,9 +219259,9 @@ webhooks: type: string enum: - prereleased - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -219565,7 +219597,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *698 sender: *4 required: - action @@ -219641,10 +219673,10 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - release: &737 + enterprise: *695 + installation: *696 + organization: *697 + release: &748 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -219977,7 +220009,7 @@ webhooks: - string - 'null' format: uri - repository: *687 + repository: *698 sender: *4 required: - action @@ -220053,11 +220085,11 @@ webhooks: type: string enum: - released - enterprise: *684 - installation: *685 - organization: *686 - release: *736 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *747 + repository: *698 sender: *4 required: - action @@ -220133,11 +220165,11 @@ webhooks: type: string enum: - unpublished - enterprise: *684 - installation: *685 - organization: *686 - release: *737 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + release: *748 + repository: *698 sender: *4 required: - action @@ -220213,11 +220245,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_advisory: *615 sender: *4 required: - action @@ -220293,11 +220325,11 @@ webhooks: type: string enum: - reported - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_advisory: *611 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_advisory: *615 sender: *4 required: - action @@ -220373,10 +220405,10 @@ webhooks: type: string enum: - archived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220453,10 +220485,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220534,10 +220566,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220622,10 +220654,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220740,10 +220772,10 @@ webhooks: - 'null' items: type: string - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220815,10 +220847,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 status: type: string @@ -220899,10 +220931,10 @@ webhooks: type: string enum: - privatized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -220979,10 +221011,10 @@ webhooks: type: string enum: - publicized - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221076,10 +221108,10 @@ webhooks: - name required: - repository - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221159,11 +221191,11 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_ruleset: *283 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_ruleset: *290 sender: *4 required: - action @@ -221241,11 +221273,11 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_ruleset: *283 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_ruleset: *290 sender: *4 required: - action @@ -221323,11 +221355,11 @@ webhooks: type: string enum: - edited - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - repository_ruleset: *283 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + repository_ruleset: *290 changes: type: object properties: @@ -221346,16 +221378,16 @@ webhooks: properties: added: type: array - items: *258 + items: *264 deleted: type: array - items: *258 + items: *264 updated: type: array items: type: object properties: - condition: *258 + condition: *264 changes: type: object properties: @@ -221388,16 +221420,16 @@ webhooks: properties: added: type: array - items: *568 + items: *571 deleted: type: array - items: *568 + items: *571 updated: type: array items: type: object properties: - rule: *568 + rule: *571 changes: type: object properties: @@ -221634,10 +221666,10 @@ webhooks: - from required: - owner - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221715,10 +221747,10 @@ webhooks: type: string enum: - unarchived - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -221796,7 +221828,7 @@ webhooks: type: string enum: - create - alert: &738 + alert: &749 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -221920,10 +221952,10 @@ webhooks: type: string enum: - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222133,10 +222165,10 @@ webhooks: type: string enum: - dismissed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222214,11 +222246,11 @@ webhooks: type: string enum: - reopen - alert: *738 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *749 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222420,10 +222452,10 @@ webhooks: enum: - fixed - open - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222441,7 +222473,7 @@ webhooks: supported-webhook-types: - repository - organization - secret-scanning-alert-created: + secret-scanning-alert-assigned: 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. @@ -222449,8 +222481,8 @@ webhooks: For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. To 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 + description: A secret scanning alert was assigned. + operationId: secret-scanning-alert/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: @@ -222494,24 +222526,24 @@ webhooks: content: application/json: schema: - title: secret_scanning_alert created event + title: secret_scanning_alert assigned event type: object properties: action: type: string enum: - - created - alert: &739 + - assigned + alert: &750 type: object properties: - number: *154 - created_at: *155 + number: *160 + created_at: *161 updated_at: anyOf: - type: 'null' - - *156 - url: *157 - html_url: *158 + - *162 + url: *163 + html_url: *164 locations_url: type: string format: uri @@ -222615,10 +222647,93 @@ webhooks: anyOf: - type: 'null' - *4 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + assignee: *4 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -222699,11 +222814,11 @@ webhooks: type: string enum: - created - alert: *739 - installation: *685 - location: *740 - organization: *686 - repository: *687 + alert: *750 + installation: *696 + location: *751 + organization: *697 + repository: *698 sender: *4 required: - location @@ -222941,11 +223056,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223023,11 +223138,11 @@ webhooks: type: string enum: - reopened - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223105,11 +223220,94 @@ webhooks: type: string enum: - resolved - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + sender: *4 + required: + - action + - alert + - repository + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: secret_scanning_alert + supported-webhook-types: + - repository + - organization + - app + secret-scanning-alert-unassigned: + 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/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + To 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 unassigned. + operationId: secret-scanning-alert/unassigned + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: *750 + assignee: *4 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223187,11 +223385,11 @@ webhooks: type: string enum: - validated - alert: *739 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + alert: *750 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -223321,10 +223519,10 @@ webhooks: - organization - enterprise - - repository: *687 - enterprise: *684 - installation: *685 - organization: *686 + repository: *698 + enterprise: *695 + installation: *696 + organization: *697 sender: *4 required: - action @@ -223402,11 +223600,11 @@ webhooks: type: string enum: - published - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: &741 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + security_advisory: &752 description: The details of the security advisory, including summary, description, and severity. type: object @@ -223423,7 +223621,7 @@ webhooks: required: - vector_string - score - cvss_severities: *48 + cvss_severities: *52 cwes: type: array items: @@ -223592,11 +223790,11 @@ webhooks: type: string enum: - updated - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 - security_advisory: *741 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 + security_advisory: *752 sender: *4 required: - action @@ -223669,10 +223867,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -223690,7 +223888,7 @@ webhooks: required: - vector_string - score - cvss_severities: *48 + cvss_severities: *52 cwes: type: array items: @@ -223858,11 +224056,11 @@ webhooks: from: type: object properties: - security_and_analysis: *257 - enterprise: *684 - installation: *685 - organization: *686 - repository: *317 + security_and_analysis: *263 + enterprise: *695 + installation: *696 + organization: *697 + repository: *319 sender: *4 required: - changes @@ -223940,12 +224138,12 @@ webhooks: type: string enum: - cancelled - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: &742 + sponsorship: &753 type: object properties: created_at: @@ -224250,12 +224448,12 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - sponsorship @@ -224343,12 +224541,12 @@ webhooks: type: string required: - from - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - changes @@ -224425,17 +224623,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &743 + effective_date: &754 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: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - sponsorship @@ -224509,7 +224707,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &744 + changes: &755 type: object properties: tier: @@ -224553,13 +224751,13 @@ webhooks: - from required: - tier - effective_date: *743 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + effective_date: *754 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - changes @@ -224636,13 +224834,13 @@ webhooks: type: string enum: - tier_changed - changes: *744 - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + changes: *755 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - sponsorship: *742 + sponsorship: *753 required: - action - changes @@ -224716,10 +224914,10 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -224803,10 +225001,10 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -225240,15 +225438,15 @@ webhooks: type: - string - 'null' - enterprise: *684 + enterprise: *695 id: description: The unique identifier of the status. type: integer - installation: *685 + installation: *696 name: type: string - organization: *686 - repository: *687 + organization: *697 + repository: *698 sender: *4 sha: description: The Commit SHA. @@ -225358,15 +225556,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - parent_issue_repo: *64 + parent_issue: *82 + parent_issue_repo: *68 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + sub_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225450,15 +225648,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - parent_issue_repo: *64 + parent_issue: *82 + parent_issue_repo: *68 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - installation: *685 - organization: *686 - repository: *687 + sub_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225542,15 +225740,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - sub_issue_repo: *64 + sub_issue: *82 + sub_issue_repo: *68 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + parent_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225634,15 +225832,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *78 - sub_issue_repo: *64 + sub_issue: *82 + sub_issue_repo: *68 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *78 - installation: *685 - organization: *686 - repository: *687 + parent_issue: *82 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -225719,12 +225917,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 - team: &745 + team: &756 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -225954,9 +226152,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -226426,7 +226624,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -226502,9 +226700,9 @@ webhooks: type: string enum: - created - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -226974,7 +227172,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -227051,9 +227249,9 @@ webhooks: type: string enum: - deleted - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -227523,7 +227721,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -227667,9 +227865,9 @@ webhooks: - from required: - permissions - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -228139,7 +228337,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - changes @@ -228217,9 +228415,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *684 - installation: *685 - organization: *686 + enterprise: *695 + installation: *696 + organization: *697 repository: title: Repository description: A git repository @@ -228689,7 +228887,7 @@ webhooks: - topics - visibility sender: *4 - team: *745 + team: *756 required: - action - team @@ -228765,10 +228963,10 @@ webhooks: type: string enum: - started - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 required: - action @@ -228841,17 +229039,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *684 + enterprise: *695 inputs: type: - object - 'null' additionalProperties: true - installation: *685 - organization: *686 + installation: *696 + organization: *697 ref: type: string - repository: *687 + repository: *698 sender: *4 workflow: type: string @@ -228933,10 +229131,10 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: allOf: @@ -229192,7 +229390,7 @@ webhooks: type: string required: - conclusion - deployment: *463 + deployment: *467 required: - action - repository @@ -229271,10 +229469,10 @@ webhooks: type: string enum: - in_progress - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: allOf: @@ -229556,7 +229754,7 @@ webhooks: required: - status - steps - deployment: *463 + deployment: *467 required: - action - repository @@ -229635,10 +229833,10 @@ webhooks: type: string enum: - queued - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: type: object @@ -229784,7 +229982,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *463 + deployment: *467 required: - action - repository @@ -229863,10 +230061,10 @@ webhooks: type: string enum: - waiting - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + enterprise: *695 + installation: *696 + organization: *697 + repository: *698 sender: *4 workflow_job: type: object @@ -230013,7 +230211,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *463 + deployment: *467 required: - action - repository @@ -230093,12 +230291,12 @@ webhooks: type: string enum: - completed - enterprise: *684 - installation: *685 - organization: *686 - repository: *687 + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}